PluginProbe
Document Gallery / 2.2.6
Document Gallery v2.2.6
trunk 0.8 0.8.5 1.0 1.0.1 1.0.2 1.0.3 1.0.4 1.1 1.2 1.2.1 1.3 1.3.1 1.4 1.4.1 1.4.2 1.4.3 2.0 2.0.1 2.0.10 2.0.2 2.0.3 2.0.4 2.0.5 2.0.6 All 94 releases
← All changes | document-gallery.php +343 -238 1.02.2.6 View file →
@@ -1,257 +1,362 @@
1 1 <?php
2 +defined('WPINC') OR exit;
3 +
2 4 /*
3 -Plugin Name: Document Gallery
4 -Description: Display non-images in gallery format on page.
5 -Version: 1.0
6 -Author: Dan Rossiter
7 -Author URI: http://danrossiter.org/
8 -License: GPL2
9 -*/
5 + Plugin Name: Document Gallery
6 + Plugin URI: http://wordpress.org/extend/plugins/document-gallery/
7 + Description: Display non-images (and images) in gallery format on a page or post with the [dg] shortcode.
8 + Version: 2.2.6
9 + Author: Dan Rossiter
10 + Author URI: http://danrossiter.org/
11 + License: GPLv2
12 + Text Domain: document-gallery
13 + */
10 14
11 -define( 'DG_URL', plugin_dir_url().'document-gallery/' );
15 +define('DG_VERSION', '2.2.6');
12 16
13 -// CREATE GALLERY STRING //
14 -function dg_get_attachment_icons($atts) {
15 - extract( shortcode_atts( array(
16 - 'descriptions' => FALSE,
17 - 'echo' => FALSE,
18 - 'orderby' => 'menu_order',
19 - 'order' => 'ASC'
20 - ), $atts) );
21 -
22 - $args = array(
23 - 'numberposts' => -1,
24 - 'orderby' => $orderby,
25 - 'order' => $order,
26 - 'post_type' => 'attachment',
27 - 'post_mime_type' => 'application,video,text,audio',
28 - 'post_parent' => get_the_ID() );
29 -
30 - if ( $attachments = get_posts($args) ) {
31 - $attachment_str = array( '<!-- GENERATED USING DOCUMENT GALLERY'.PHP_EOL.
32 - ' http://wordpress.org/extend/plugins/document-gallery -->'.PHP_EOL );
17 +// define helper paths & URLs
18 +define('DG_BASENAME', plugin_basename(__FILE__));
19 +define('DG_URL', plugin_dir_url(__FILE__));
20 +define('DG_PATH', plugin_dir_path(__FILE__));
21 +define('DG_WPINC_PATH', ABSPATH . WPINC . '/');
22 +define('DG_WPADMIN_PATH', ABSPATH . 'wp-admin/');
33 23
34 - if($descriptions) {
35 - $attachment_str[] = '<table id="document-icon-wrapper">';
36 - } else {
37 - $attachment_str[] = '<div id="document-icon-wrapper">';
38 - }
24 +// init DG options for use throughout plugin
25 +global $dg_options;
26 +define('DG_OPTION_NAME', 'document_gallery');
27 +$dg_options = get_option(DG_OPTION_NAME, null);
39 28
40 - $count = 0;
41 - foreach( $attachments as $attachment ) { //setup array for more than one file attachment
42 - $url = wp_get_attachment_url( $attachment->ID );
43 - $title = wp_get_attachment_link( $attachment->ID );
44 - $icon = dg_get_attachment_icon( $attachment->ID, $tile, $url );
45 -
46 - if($descriptions) {
47 - $attachment_str[] = '<tr><td class="document-icon">';
48 - } else {
49 - $attachment_str[] = '<div class="document-icon">';
50 - }
29 +// logging functionality
30 +include_once DG_PATH . 'inc/class-logger.php';
51 31
52 - $attachment_str[] = "<a href=\"$url\">$icon</a><br><a href=\"$url\">$title</a>";
32 +// handle activation, updates, and uninstallation
33 +include_once DG_PATH . 'inc/class-setup.php';
34 +register_activation_hook(__FILE__, array('DG_Setup', 'activate'));
35 +add_action('wpmu_new_blog', array('DG_Setup','activateNewBlog'));
36 +register_uninstall_hook(__FILE__, array('DG_Setup', 'uninstall'));
37 +DG_Setup::maybeUpdate();
53 38
54 - if($descriptions) {
55 - $attachment_str[] = "</td><td valign=\"top\"><p>$attachment->post_content</p></td></tr>";
56 - } else {
57 - $attachment_str[] = '</div>';
58 - if( ++$count % 4 == 0 ) {
59 - $attachment_str[] = '<hr>';
60 - }
61 - }
62 - } // end looping attachments
39 +// validate options if desired
40 +if ($dg_options['validation']) {
41 + add_action('init', array('DocumentGallery', 'addValidation'));
42 +}
63 43
64 - // close #document-icon-wrapper
65 - if($descriptions) {
66 - $attachment_str[] = '</table>';
67 - } else {
68 - $attachment_str[] = '</div>';
69 - }
44 +// I18n
45 +add_action('plugins_loaded', array('DocumentGallery', 'loadTextDomain'));
70 46
71 - // join array & return
72 - $attachment_str = implode( '', $attachment_str );
73 - return $attachment_str;
74 - } // end if attachments
75 -
76 - return '<!-- Document Gallery: No attachments to display. -->'.PHP_EOL;
47 +// cleanup cached data when thumbed attachment deleted
48 +include_once DG_PATH . 'inc/class-thumber.php';
49 +add_action('delete_attachment', array('DG_Thumber', 'deleteThumbMeta'));
50 +
51 +if (is_admin()) {
52 + // admin house keeping
53 + include_once DG_PATH . 'admin/class-admin.php';
54 +
55 + // add settings link
56 + add_filter('plugin_action_links_' . DG_BASENAME, array('DG_Admin', 'addSettingsLink'));
57 +
58 + // build options page
59 + add_action('admin_menu', array('DG_Admin', 'addAdminPage'));
60 + if (DG_Admin::doRegisterSettings()) {
61 + add_action('admin_init', array('DG_Admin', 'registerSettings'));
62 + }
63 +} else {
64 + // styling for gallery
65 + if (empty($dg_options['css']['text'])) {
66 + add_action('wp_enqueue_scripts', array('DocumentGallery', 'enqueueGalleryStyle'));
67 + } else {
68 + add_action('template_redirect', array('DocumentGallery', 'buildCustomCss'));
69 + add_action('wp_enqueue_scripts', array('DocumentGallery', 'enqueueCustomStyle'));
70 + add_filter('query_vars', array('DocumentGallery', 'addCustomStyleQueryVar'));
71 + }
77 72 }
78 -add_shortcode('document gallery', 'dg_get_attachment_icons');
79 -add_shortcode('dg', 'dg_get_attachment_icons');
80 73
74 +// adds 'dg' shortcode
75 +add_shortcode('dg', array('DocumentGallery', 'doShortcode'));
81 76
82 -// ADD SOME STYLING //
83 -function dg_add_header_css() {
84 - wp_enqueue_style( 'document-gallery-css', plugins_url('style.css', __FILE__) );
85 -}
86 -add_action( 'wp_print_styles', 'dg_add_header_css');
77 +/**
78 + * DocumentGallery wraps basic functionality to setup the plugin.
79 + *
80 + * @author drossiter
81 + */
82 +class DocumentGallery {
87 83
84 + /**
85 + * @var str Name of the query var used to check whether we should print custom CSS.
86 + */
87 + private static $query_var = 'document-gallery-css';
88 88
89 -// HELPERS //
89 + /*==========================================================================
90 + * THE SHORTCODE
91 + *=========================================================================*/
90 92
91 -// pass in $title & $url to avoid mult function calls
92 -function dg_get_attachment_icon( $id, $title, $url ) {
93 - $filename = basename( $url );
94 - $filetype = wp_check_filetype( $filename );
93 + /**
94 + * Takes values passed from attributes and returns sutable HTML to represent
95 + * all valid attachments requested.
96 + *
97 + * @param multitype:string $atts Arguments from the user.
98 + * @return string HTML for the Document Gallery.
99 + */
100 + public static function doShortcode($atts) {
101 + include_once 'inc/class-gallery.php';
95 102
96 - // identify extension
97 - switch( $filetype['ext'] ) {
98 - // Most Common First
99 - case 'pdf':
100 - $icon = 'pdf.png';
101 - break;
102 - // MS Office
103 - case 'doc':
104 - case 'docx':
105 - case 'docm':
106 - case 'dotx':
107 - case 'dotm':
108 - $icon = 'msdoc.png';
109 - break;
110 - case 'ppt':
111 - case 'pot':
112 - case 'pps':
113 - case 'pptx':
114 - case 'pptm':
115 - case 'ppsx':
116 - case 'ppsm':
117 - case 'potx':
118 - case 'potm':
119 - case 'ppam':
120 - case 'sldx':
121 - case 'sldm':
122 - $icon = 'msppt.png';
123 - break;
124 - case 'xla':
125 - case 'xls':
126 - case 'xlt':
127 - case 'xlw':
128 - case 'xlsx':
129 - case 'xlsm':
130 - case 'xlsb':
131 - case 'xltx':
132 - case 'xltm':
133 - case 'xlam':
134 - $icon = 'msxls.png';
135 - break;
136 - case 'mdb':
137 - $icon = 'msaccess.png';
138 - break;
139 - // Video formats
140 - case 'avi':
141 - $icon = 'avi.png';
142 - break;
143 - case 'divx':
144 - $icon = 'divx.png';
145 - break;
146 - case 'flv':
147 - $icon = 'flv.png';
148 - break;
149 - case 'qt':
150 - case 'mov':
151 - $icon = 'mov.png';
152 - break;
153 - case 'asf':
154 - case 'asx':
155 - case 'wax':
156 - case 'wmv':
157 - case 'wmx':
158 - $icon = 'wmv.png';
159 - break;
160 - case 'mkv':
161 - $icon = 'mkv.png';
162 - break;
163 - // Audio formats
164 - case 'mp3':
165 - $icon = 'mp3.png';
166 - break;
167 - case 'wav':
168 - $icon = 'wav.png';
169 - break;
170 - case 'ogg':
171 - case 'oga':
172 - $icon = 'ogg.png';
173 - break;
174 - case 'midi':
175 - case 'mid':
176 - $icon = 'midi.png';
177 - break;
178 - case 'wma':
179 - $icon = 'wma.png';
180 - break;
181 - // Text formats
182 - case 'rtx':
183 - $icon = 'rtx.png';
184 - break;
185 - case 'ics':
186 - $icon = 'ics.png';
187 - break;
188 - case 'csv':
189 - $icon = 'csv.png';
190 - break;
191 - // Msc application formats
192 - case 'html':
193 - case 'htm': // death to all who use this!
194 - $icon = 'html.png';
195 - break;
196 - case 'css':
197 - $icon = 'css.png';
198 - break;
199 - case 'js':
200 - $icon = 'javascript.png';
201 - break;
202 - case 'class':
203 - $icon = 'java.png';
204 - break;
205 - case 'zip':
206 - $icon = 'zip.png';
207 - break;
208 - case 'tar':
209 - case 'gzip':
210 - case 'gz':
211 - case 'bz2': // not yet WP-supported
212 - case 'tgz': // not yet WP-supported
213 - $icon = 'compressed.png';
214 - break;
215 - case 'rar': // RAWR!!!
216 - $icon = 'rar.png';
217 - break;
218 - case '7z':
219 - $icon = '7zip.png';
220 - break;
221 - case 'exec':
222 - $icon = 'exec.png';
223 - break;
224 - case 'rtf':
225 - $icon = 'rtf.png';
226 - break;
227 - case 'swf':
228 - $icon = 'shockwave.png';
229 - break;
230 - // OpenOffice formats
231 - case 'odt':
232 - $icon = 'opendocument-text.png';
233 - break;
234 - case 'odp':
235 - $icon = 'opendocument-presentation.png';
236 - break;
237 - case 'ods':
238 - $icon = 'opendocument-spreadsheet.png';
239 - break;
240 - case 'odg':
241 - $icon = 'opendocument-graphics.png';
242 - break;
243 - case 'odb':
244 - $icon = 'opendocument-database.png';
245 - break;
246 - case 'odf':
247 - $icon = 'opendocument-formula.png';
248 - break;
249 - // fallback to default icons if not recognized
250 - default:
251 - return get_attachment_icon( $id );
252 - }
103 + $start = microtime(true);
104 + $gallery = (string)new DG_Gallery($atts);
105 + DG_Logger::writeLog(DG_LogLevel::Detail, 'Generation Time: ' . sprintf('%.2f', (microtime(true) - $start)) . ' s');
253 106
254 - $icon = '<img src="'.DG_URL.'icons/'.$icon."\" title=\"$title\" alt=\"$title\"/>";
255 - return $icon;
107 + return $gallery;
108 + }
109 +
110 + /**
111 + * Enqueue standard DG CSS.
112 + */
113 + public static function enqueueGalleryStyle() {
114 + wp_enqueue_style('document-gallery', DG_URL . 'assets/css/style.css', null, DG_VERSION);
115 + }
116 +
117 + /**
118 + * Enqueue user's custom DG CSS.
119 + */
120 + public static function enqueueCustomStyle() {
121 + global $dg_options;
122 + wp_register_style('document-gallery', add_query_arg(self::$query_var, 1, home_url('/')),
123 + null, DG_VERSION . ':' . $dg_options['css']['version']);
124 + wp_enqueue_style('document-gallery');
125 + }
126 +
127 + /**
128 + * Add query custom CSS query string.
129 + * Taken from here: http://ottopress.com/2010/dont-include-wp-load-please/
130 + * @param multitype:string $vars Variables to be added.
131 + * @return multitype:string All variables to be included in query string.
132 + */
133 + public static function addCustomStyleQueryVar($vars) {
134 + $vars[] = self::$query_var;
135 + return $vars;
136 + }
137 +
138 + /**
139 + * Constructs user's custom CSS dynamically, then instructs
140 + * browser to cache for a year. Cache is busted by versioning
141 + * CSS any time the user makes a change.
142 + */
143 + public static function buildCustomCss() {
144 + if (1 == intval(get_query_var(self::$query_var))) {
145 + global $dg_options;
146 +
147 + header('Content-type: text/css');
148 + header('Cache-Control: no-transform,public,maxage=' . 31536000);
149 + header('Expires: ' . gmdate('D, d M Y H:i:s', time() + 31536000) . ' GMT');
150 + header('Last-Modified: ' . $dg_options['css']['last-modified']);
151 + header('ETag: ' . $dg_options['css']['etag']);
152 +
153 + echo $dg_options['css']['minified'];
154 + exit;
155 + }
156 + }
157 +
158 + /*==========================================================================
159 + * I18n
160 + *=========================================================================*/
161 +
162 + /**
163 + * Loads language files into WP core.
164 + */
165 + public static function loadTextDomain() {
166 + load_plugin_textdomain('document-gallery', false, dirname(DG_BASENAME) . '/languages/');
167 + }
168 +
169 + /*==========================================================================
170 + * HELPER FUNCTIONS
171 + *=========================================================================*/
172 +
173 + /**
174 + * @param int $blog ID of the blog to be retrieved in multisite env.
175 + * @return multitype:unknown Options for the blog.
176 + */
177 + public static function getOptions($blog = null) {
178 + global $dg_options;
179 + return is_null($blog)
180 + ? $dg_options
181 + : get_blog_option($blog, DG_OPTION_NAME, null);
182 + }
183 +
184 + /**
185 + * @param multitype:unknown $options
186 + * @param int $blog ID of the blog to be set in multisite env.
187 + */
188 + public static function setOptions($options, $blog = null) {
189 + if (is_null($blog)) {
190 + global $dg_options;
191 + update_option(DG_OPTION_NAME, $options);
192 + $dg_options = $options;
193 + } else {
194 + update_blog_option($blog, DG_OPTION_NAME, $options);
195 + }
196 + }
197 +
198 + /**
199 + * @param int $blog ID of the blog to be deleted in multisite env.
200 + */
201 + public static function deleteOptions($blog = null) {
202 + if (is_null($blog)) {
203 + delete_option(DG_OPTION_NAME);
204 + } else {
205 + delete_blog_option($blog, DG_OPTION_NAME);
206 + }
207 + }
208 +
209 + /**
210 + * Adds hook to validate DG options every time save is attempted.
211 + */
212 + public static function addValidation() {
213 + add_filter('pre_update_option_' . DG_OPTION_NAME, array('DocumentGallery', 'validateOptionsStructure'), 10, 2);
214 + }
215 +
216 + /**
217 + * Checks whether the given options match the option schema.
218 + * @param multivar $new The new options to be validated.
219 + * @param multivar $old The old options.
220 + * @return array The options to be saved.
221 + */
222 + public static function validateOptionsStructure($new, $old) {
223 + if (self::isValidOptionsStructure($new)) {
224 + $ret = $new;
225 + } else {
226 + $ret = $old;
227 + DG_Logger::writeLog(DG_LogLevel::Error, 'Attempted to save invalid options.' . PHP_EOL . print_r($new, true), true, true);
228 + }
229 +
230 + return $ret;
231 + }
232 +
233 + /**
234 + * @param multivar|unknown $o The options structure to validate.
235 + * @param multivar $schema The schema to validate against (note that only keys matter -- non-array values are ignored).
236 + * @return bool Whether the given options structure matches the schema.
237 + */
238 + private static function isValidOptionsStructure($o, $schema = null) {
239 + if (is_null($schema)) {
240 + include_once DG_PATH . 'inc/class-setup.php';
241 + $schema = DG_Setup::getDefaultOptions(true);
242 + }
243 +
244 + // simple checks first
245 + $valid = is_array($o) && (count($schema) === count($o));
246 +
247 + if ($valid) {
248 + foreach ($schema as $sk => $sv) {
249 + $valid = array_key_exists($sk, $o);
250 + if (is_array($sv) && !empty($sv)) {
251 + $valid = $valid && self::isValidOptionsStructure($o[$sk], $sv);
252 + }
253 +
254 + if (!$valid) {
255 + break;
256 + }
257 + }
258 + }
259 +
260 + return $valid;
261 + }
262 +
263 + /**
264 + * Function takes a GMT timestamp and returns a date/time string in the
265 + * current timezone and WP format.
266 + * @param int $timestamp The GMT timestamp to translate.
267 + * @return string The local time in the WP date/time format.
268 + */
269 + public static function localDateTimeFromTimestamp($timestamp) {
270 + static $gmt_offet = null;
271 + static $wp_format = null;
272 + if (is_null($gmt_offet)) {
273 + $gmt_offet = get_option('gmt_offset');
274 + $wp_format = get_option('date_format').' '.get_option('time_format');
275 + }
276 +
277 + return date($wp_format, $timestamp + $gmt_offet * 3600);
278 + }
279 +
280 + /**
281 + * Compiles any custom CSS plus the default CSS together,
282 + * minifying in the process.
283 + * @param string $custom The custom CSS to compile.
284 + * @return string Compiled CSS, including both standard and any custom.
285 + */
286 + public static function compileCustomCss($custom) {
287 + $css = file_get_contents(DG_PATH . 'assets/css/style.css');
288 + $css .= str_replace('&gt;', '>', esc_html($custom));
289 +
290 + return $css;
291 + }
292 +
293 + /**
294 + * Removes all comments & space from CSS string.
295 + * Source: http://stackoverflow.com/a/15195752/866618
296 + */
297 + private static function minifyCss($css) {
298 + # remove comments first (simplifies the other regex)
299 + $re1 = <<<EOS
300 +(?sx)
301 + # quotes
302 + (
303 + "(?:[^"\\]++|\\.)*+"
304 + | '(?:[^'\\]++|\\.)*+'
305 + )
306 +|
307 + # comments
308 + /\* (?> .*? \*/ )
309 +EOS;
310 +
311 + $re2 = <<<EOS
312 +(?six)
313 + # quotes
314 + (
315 + "(?:[^"\\]++|\\.)*+"
316 + | '(?:[^'\\]++|\\.)*+'
317 + )
318 +|
319 + # ; before } (and the spaces after it while we're here)
320 + \s*+ ; \s*+ ( } ) \s*+
321 +|
322 + # all spaces around meta chars/operators
323 + \s*+ ( [*$~^|]?+= | [{};,>~+-] | !important\b ) \s*+
324 +|
325 + # spaces right of ( [ :
326 + ( [[(:] ) \s++
327 +|
328 + # spaces left of ) ]
329 + \s++ ( [])] )
330 +|
331 + # spaces left (and right) of :
332 + \s++ ( : ) \s*+
333 + # but not in selectors: not followed by a {
334 + (?!
335 + (?>
336 + [^{}"']++
337 + | "(?:[^"\\]++|\\.)*+"
338 + | '(?:[^'\\]++|\\.)*+'
339 + )*+
340 + {
341 + )
342 +|
343 + # spaces at beginning/end of string
344 + ^ \s++ | \s++ \z
345 +|
346 + # double spaces to single
347 + (\s)\s+
348 +EOS;
349 +
350 + $css = preg_replace("%$re1%", '$1', $css);
351 + return preg_replace("%$re2%", '$1$2$3$4$5$6$7', $css);
352 + }
353 +
354 + /**
355 + * Blocks instantiation. All functions are static.
356 + */
357 + private function __construct() {
358 +
359 + }
256 360 }
257 -?>
361 +
362 +?>