1: <?php
  2: 
  3: /**
  4:  * A quota management system to limit the sum of sizes of uploaded images.
  5:  *
  6:  * Set the default quota on the plugin options page.
  7:  * You can change the quota for individual users on the Admin tab. Users with <var>ADMIN_RIGHTS</var> or <var>MANAGE_ALL_ALBUM_RIGHTS</var>
  8:  * are not subject to quotas and will not be assigned ownership of an image.
  9:  *
 10:  * Images uploaded by a user will be marked as his and will count toward his quota.
 11:  * Images uploaded via FTP or from the <var>files</var> tab will not necessarily have an owner assigned.
 12:  *
 13:  * You may also assign the complete set of images in an albums to a user. (Just the images in the
 14:  * album. If you want to assign images from subalbums, you need to do that for each
 15:  * subalbum.)
 16:  *
 17:  * A user who exceeds his quota will not be allowed to upload more files.
 18:  *
 19:  * Because of the difficulty of policing quotas when ZIP files are uploaded this plugin
 20:  * has an option to diable ZIP file upload.
 21:  *
 22:  * Since uploads via the <var>files</var> tab are like FTP uploads and are not assigned to the user, you should not assign <var>files</var> rights
 23:  * to users with upload limits.
 24:  *
 25:  * @author Stephen Billard (sbillard)
 26:  * @package plugins
 27:  * @subpackage users
 28:  */
 29: $plugin_is_filter = 5 | ADMIN_PLUGIN;
 30: $plugin_description = gettext("Provides a quota management system to limit the sum of sizes of images a user uploads.");
 31: $plugin_notice = gettext("<strong>Note:</strong> if FTP is used to upload images, manual user assignment is necessary. ZIP file upload is disabled by default as quotas are not applied to the files contained therein.");
 32: $plugin_author = "Stephen Billard (sbillard)";
 33: $plugin_disable = (zp_has_filter('get_upload_header_text') && !extensionEnabled('quota_manager')) ? sprintf(gettext('<a href="#%1$s"><code>%1$s</code></a> is already enabled.'), stripSuffix(get_filterScript('get_upload_header_text'))) : '';
 34: 
 35: $option_interface = 'quota_manager';
 36: 
 37: if ($plugin_disable) {
 38:     enableExtension('quota_manager', 0);
 39: } else {
 40:     zp_register_filter('save_admin_custom_data', 'quota_manager::save_admin');
 41:     zp_register_filter('edit_admin_custom_data', 'quota_manager::edit_admin');
 42:     zp_register_filter('new_image', 'quota_manager::new_image');
 43:     zp_register_filter('image_refresh', 'quota_manager::image_refresh');
 44:     zp_register_filter('check_upload_quota', 'quota_manager::checkQuota');
 45:     zp_register_filter('get_upload_limit', 'quota_manager::getUploadLimit');
 46:     zp_register_filter('get_upload_header_text', 'quota_manager::get_header');
 47:     zp_register_filter('upload_filetypes', 'quota_manager::upload_filetypes');
 48:     zp_register_filter('upload_helper_js', 'quota_manager::upload_helper_js');
 49: }
 50: 
 51: /**
 52:  * Option handler class
 53:  *
 54:  */
 55: class quota_manager {
 56: 
 57:     /**
 58:      * class instantiation function
 59:      *
 60:      * @return filter_zenphoto_seo
 61:      */
 62:     function __construct() {
 63:         setOptionDefault('quota_default', 250000);
 64:         setOptionDefault('quota_allowZIP', 1);
 65:     }
 66: 
 67:     /**
 68:      * Reports the supported options
 69:      *
 70:      * @return array
 71:      */
 72:     function getOptionsSupported() {
 73:         return array(gettext('Default quota')    => array('key'  => 'quota_default', 'type' => OPTION_TYPE_TEXTBOX,
 74:                                         'desc' => gettext('Default size limit in kilobytes.')),
 75:                         gettext('Allow ZIP files') => array('key'    => 'quota_allowZIP', 'type' => OPTION_TYPE_CHECKBOX,
 76:                                         'desc' => gettext('The size of a ZIP file may be slightly smaller than the sum of the <em>image</em> files it contains. Un-check this box if you wish to disable uploading of ZIP files.'))
 77:         );
 78:     }
 79: 
 80:     function handleOption($option, $currentValue) {
 81: 
 82:     }
 83: 
 84:     /**
 85:      * Saves admin custom data
 86:      * Called when an admin is saved
 87:      *
 88:      * @param string $updated true if data has changed
 89:      * @param object $userobj admin user object
 90:      * @param string $i prefix for the admin
 91:      * @param bool $alter will be true if critical admin data may be altered
 92:      * @return bool
 93:      */
 94:     static function save_admin($updated, $userobj, $i, $alter) {
 95:         if (isset($_POST[$i . 'quota']) && $alter) {
 96:             $oldquota = $userobj->getQuota();
 97:             $userobj->setQuota(sanitize_numeric($_POST[$i . 'quota']));
 98:             if ($oldquota != $userobj->getQuota()) {
 99:                 $updated = true;
100:             }
101:         }
102:         return $updated;
103:     }
104: 
105:     /**
106:      * Returns table row(s) for edit of an admin user's custom data
107:      *
108:      * @param string $html always empty
109:      * @param $userobj Admin user object
110:      * @param string $i prefix for the admin
111:      * @param string $background background color for the admin row
112:      * @param bool $current true if this admin row is the logged in admin
113:      * @return string
114:      */
115:     static function edit_admin($html, $userobj, $i, $background, $current, $local_alterrights) {
116:         if ($userobj->getRights() & (ADMIN_RIGHTS | MANAGE_ALL_ALBUM_RIGHTS))
117:             return $html;
118:         if (!($userobj->getRights() & UPLOAD_RIGHTS))
119:             return $html;
120:         $quota = $userobj->getQuota();
121:         if ($quota == NULL) {
122:             $quota = getOption('quota_default');
123:         }
124:         if ($userobj->getValid()) {
125:             $used = sprintf(gettext('(%s kb used)'), number_format(quota_manager::getCurrentUse($userobj)));
126:         } else {
127:             $used = '';
128:         }
129:         $result =
130:                         '<tr' . ((!$current) ? ' style="display:none;"' : '') . ' class="userextrainfo">
131:                 <td colspan="2"' . ((!empty($background)) ? ' style="' . $background . '"' : '') . ' valign="top" width="345">' . gettext("Image storage quota:") . '&nbsp;' .
132:                         sprintf(gettext('Allowed: %s kb'), '<input type="text" size="10" name="' . $i . 'quota" value="' . $quota . '" ' . $local_alterrights . ' />') . ' ' .
133:                         $used .
134:                         "\n" .
135:                         '</td>' .
136:                         '</tr>' . "\n";
137:         return $html . $result;
138:     }
139: 
140:     /**
141:      * Returns current image useage
142:      * @param $userobj Admin user object
143:      * @return int
144:      */
145:     static function getCurrentUse($userobj) {
146:         global $_zp_current_admin_obj;
147:         if (is_null($userobj)) {
148:             $userobj = $_zp_current_admin_obj;
149:         }
150:         $sql = 'SELECT sum(`filesize`) FROM ' . prefix('images') . ' WHERE `owner`="' . $userobj->getUser() . '"';
151:         $result = query_single_row($sql);
152:         return array_shift($result) / 1024;
153:     }
154: 
155:     /**
156:      * Assigns owner to new image
157:      * @param string $image
158:      * @return object
159:      */
160:     static function new_image($image) {
161:         global $_zp_current_admin_obj;
162:         if (is_object($_zp_current_admin_obj)) {
163:             $image->set('owner', $_zp_current_admin_obj->getUser());
164:         }
165:         $image->set('filesize', filesize($image->localpath));
166:         $image->save();
167:         return $image;
168:     }
169: 
170:     /**
171:      * checks to see if the filesize is set and sets it if not
172:      * @param unknown_type $image
173:      * @return object
174:      */
175:     static function image_refresh($image) {
176:         $image->set('filesize', filesize($image->localpath));
177:         $image->save();
178:         return $image;
179:     }
180: 
181:     /**
182:      * Returns the user's quota
183:      * @param int $quota
184:      * @return int
185:      */
186:     static function getUploadQuota($quota) {
187:         global $_zp_current_admin_obj;
188:         if (zp_loggedin(MANAGE_ALL_ALBUM_RIGHTS)) {
189:             $quota = -1;
190:         } else {
191:             $quota = $_zp_current_admin_obj->getQuota();
192:             if ($quota == NULL)
193:                 $quota = getOption('quota_default');
194:         }
195:         return $quota;
196:     }
197: 
198:     /**
199:      * Returns the upload limit
200:      * @param int $uploadlimit
201:      * @return int
202:      */
203:     static function getUploadLimit($uploadlimit) {
204:         if (!zp_loggedin(MANAGE_ALL_ALBUM_RIGHTS)) {
205:             $uploadlimit = (quota_manager::getUploadQuota(0) - quota_manager::getCurrentUse(NULL)) * 1024;
206:         }
207:         return $uploadlimit;
208:     }
209: 
210:     /**
211:      * Checks if upload should be allowed
212:      * @param int $error
213:      * @param string $image
214:      * @return int
215:      */
216:     static function checkQuota($error, $image) {
217:         if (zp_loggedin(MANAGE_ALL_ALBUM_RIGHTS)) {
218:             return UPLOAD_ERR_OK;
219:         }
220:         if (getSuffix($image) == 'zip') {
221:             return UPLOAD_ERR_EXTENSION;
222:         }
223:         $quota = quota_manager::getUploadQuota(0);
224:         if ($image) {
225:             $size = round(filesize($image) / 1024);
226:         } else {
227:             $size = 0; //   no image passed, just want to see if we are at or above quota.
228:         }
229:         if ($quota > 0) {
230:             if (quota_manager::getCurrentUse(NULL) + $size >= $quota) {
231:                 $error = UPLOAD_ERR_QUOTA;
232:             }
233:         }
234:         return $error;
235:     }
236: 
237:     /**
238:      * Returns quota text for header, etc.
239:      * @param string $default
240:      * @return string
241:      */
242:     static function get_header($default) {
243:         if (zp_loggedin(MANAGE_ALL_ALBUM_RIGHTS)) {
244:             return $default;
245:         }
246:         $uploadlimit = quota_manager::getUploadLimit(0);
247:         if ($uploadlimit <= 1024) {
248:             $color = 'style="color:red;"';
249:             $warn = ' <span style="color:red;">' . gettext('Uploading is disabled.') . '</span>';
250:         } else {
251:             $color = '';
252:             $warn = '';
253:         }
254:         return sprintf(gettext('Your available upload quota is <span %1$s>%2$s</span> kb.'), $color, number_format(round($uploadlimit / 1024))) . $warn;
255:     }
256: 
257:     /**
258:      * Returns Javascript needed to support quota system
259:      * @param string $defaultJS
260:      * @return string
261:      */
262:     static function upload_helper_js($defaultJS) {
263:         $quota = quota_manager::getUploadLimit(99999);
264:         $quotaOK = $quota < 0 || $quota > 1024;
265:         if ($quotaOK) {
266:             $quota_management_js = '';
267:         } else {
268:             $quota_management_js = "
269:                 $(document).ready(function() {
270:                     $('#albumselect').hide();
271:                 });";
272:         }
273:         return $quota_management_js . $defaultJS;
274:     }
275: 
276:     /**
277:      * Removes ZIP from list of upload suffixes
278:      * @param array $types
279:      * @return array
280:      */
281:     static function upload_filetypes($types) {
282:         if (zp_loggedin(MANAGE_ALL_ALBUM_RIGHTS) || (getoption('quota_allowZIP'))) {
283:             return $types;
284:         }
285:         $key = array_search('ZIP', $types);
286:         if ($key !== false)
287:             unset($types[$key]);
288:         return $types;
289:     }
290: 
291: }
292: 
293: ?>