includes/functions-plugins.php

   1 <?php
   2
   3 /**
   4  * The filter/plugin API is located in this file, which allows for creating filters
   5  * and hooking functions, and methods. The functions or methods will be run when
   6  * the filter is called.
   7  *
   8  * Any of the syntaxes explained in the PHP documentation for the
   9  * {@link http://us2.php.net/manual/en/language.pseudo-types.php#language.types.callback 'callback'}
  10  * type are valid.
  11  *
  12  * This API is heavily inspired by the one I implemented in Zenphoto 1.3, which was heavily inspired by the one used in WordPress.
  13  *
  14  * @author Ozh
  15  * @since 1.5
  16  */
  17
  18 if( !isset( $yourls_filters ) )
  19     $yourls_filters = array();
  20 /* This global var will collect filters with the following structure:
  21  * $yourls_filters['hook']['array of priorities']['serialized function names']['array of ['array (functions, accepted_args, filter or action)]']
  22  */
  23
  24 if( !isset( $yourls_actions ) )
  25     $yourls_actions = array();
  26 /* This global var will collect 'done' actions with the following structure:
  27  * $yourls_actions['hook'] => number of time this action was done
  28  */
  29
  30 /**
  31  * Registers a filtering function
  32  *
  33  * Typical use:
  34  *              yourls_add_filter('some_hook', 'function_handler_for_hook');
  35  *
  36  * @global array $yourls_filters Storage for all of the filters
  37  * @param string $hook the name of the YOURLS element to be filtered or YOURLS action to be triggered
  38  * @param callback $function_name the name of the function that is to be called.
  39  * @param integer $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default=10, lower=earlier execution, and functions with the same priority are executed in the order in which they were added to the filter)
  40  * @param int $accepted_args optional. The number of arguments the function accept (default is the number provided).
  41  * @param string $type
  42  */
  43 function yourls_add_filter( $hook, $function_name, $priority = 10, $accepted_args = NULL, $type = 'filter' ) {
  44         global $yourls_filters;
  45         // At this point, we cannot check if the function exists, as it may well be defined later (which is OK)
  46         $id = yourls_filter_unique_id( $hook, $function_name, $priority );
  47
  48         $yourls_filters[ $hook ][ $priority ][ $id ] = array(
  49                 'function'      => $function_name,
  50                 'accepted_args' => $accepted_args,
  51                 'type'          => $type,
  52         );
  53 }
  54
  55 /**
  56  * Hooks a function on to a specific action.
  57  *
  58  * Actions are the hooks that YOURLS launches at specific points
  59  * during execution, or when specific events occur. Plugins can specify that
  60  * one or more of its PHP functions are executed at these points, using the
  61  * Action API.
  62  *
  63  * @param string $hook The name of the action to which the $function_to_add is hooked.
  64  * @param callback $function_name The name of the function you wish to be called.
  65  * @param int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action.
  66  * @param int $accepted_args optional. The number of arguments the function accept (default 1).
  67  */
  68 function yourls_add_action( $hook, $function_name, $priority = 10, $accepted_args = 1 ) {
  69         return yourls_add_filter( $hook, $function_name, $priority, $accepted_args, 'action' );
  70 }
  71
  72
  73
  74 /**
  75  * Build Unique ID for storage and retrieval.
  76  *
  77  * Simply using a function name is not enough, as several functions can have the same name when they are enclosed in classes.
  78  *
  79  * @global array $yourls_filters storage for all of the filters
  80  * @param string $hook hook to which the function is attached
  81  * @param string|array $function used for creating unique id
  82  * @param int|bool $priority used in counting how many hooks were applied.  If === false and $function is an object reference, we return the unique id only if it already has one, false otherwise.
  83  * @return string unique ID for usage as array key
  84  */
  85 function yourls_filter_unique_id( $hook, $function, $priority ) {
  86         global $yourls_filters;
  87
  88         // If function then just skip all of the tests and not overwrite the following.
  89         if ( is_string( $function ) ) {
  90                 return $function;
  91     }
  92
  93         if( is_object($function) ) {
  94                 // Closures are currently implemented as objects
  95                 $function = array( $function, '' );
  96         } else {
  97                 $function = (array) $function;
  98         }
  99
 100         // Object Class Calling
 101         if ( is_object( $function[0] ) ) {
 102         return spl_object_hash( $function[0] ) . $function[1];
 103         }
 104
 105     // Static Calling
 106     if ( is_string( $function[0] ) ) {
 107                 return $function[0]. '::' .$function[1];
 108     }
 109
 110 }
 111
 112 /**
 113  * Performs a filtering operation on a YOURLS element or event.
 114  *
 115  * Typical use:
 116  *
 117  *              1) Modify a variable if a function is attached to hook 'yourls_hook'
 118  *              $yourls_var = "default value";
 119  *              $yourls_var = yourls_apply_filter( 'yourls_hook', $yourls_var );
 120  *
 121  *              2) Trigger functions is attached to event 'yourls_event'
 122  *              yourls_apply_filter( 'yourls_event' );
 123  *      (see yourls_do_action() )
 124  *
 125  * Returns an element which may have been filtered by a filter.
 126  *
 127  * @global array $yourls_filters storage for all of the filters
 128  * @param string $hook the name of the YOURLS element or action
 129  * @param mixed $value the value of the element before filtering
 130  * @return mixed
 131  */
 132 function yourls_apply_filter( $hook, $value = '' ) {
 133         global $yourls_filters;
 134         if ( !isset( $yourls_filters[ $hook ] ) )
 135                 return $value;
 136
 137         $args = func_get_args();
 138
 139         // Sort filters by priority
 140         ksort( $yourls_filters[ $hook ] );
 141
 142         // Loops through each filter
 143         reset( $yourls_filters[ $hook ] );
 144         do {
 145                 foreach( (array) current( $yourls_filters[ $hook ] ) as $the_ ) {
 146                         if ( !is_null( $the_['function'] ) ){
 147                                 $args[1] = $value;
 148                                 $count = $the_['accepted_args'];
 149                                 if ( is_null( $count ) ) {
 150                                         $_value = call_user_func_array( $the_['function'], array_slice( $args, 1 ) );
 151                                 } else {
 152                                         $_value = call_user_func_array( $the_['function'], array_slice( $args, 1, (int) $count ) );
 153                                 }
 154                         }
 155                         if( $the_['type'] == 'filter' )
 156                                 $value = $_value;
 157                 }
 158
 159         } while ( next( $yourls_filters[ $hook ] ) !== false );
 160
 161         if( $the_['type'] == 'filter' )
 162                 return $value;
 163 }
 164
 165 /**
 166  * Performs an action triggered by a YOURLS event.
 167 *
 168  * @param string $hook the name of the YOURLS action
 169  * @param mixed $arg action arguments
 170  */
 171 function yourls_do_action( $hook, $arg = '' ) {
 172         global $yourls_actions;
 173
 174         // Keep track of actions that are "done"
 175         if ( !isset( $yourls_actions ) )
 176                 $yourls_actions = array();
 177         if ( !isset( $yourls_actions[ $hook ] ) ) {
 178                 $yourls_actions[ $hook ] = 1;
 179     } else {
 180                 ++$yourls_actions[ $hook ];
 181     }
 182
 183         $args = array();
 184         if ( is_array( $arg ) && 1 == count( $arg ) && isset( $arg[0] ) && is_object( $arg[0] ) ) // array(&$this)
 185                 $args[] =& $arg[0];
 186         else
 187                 $args[] = $arg;
 188         for ( $a = 2; $a < func_num_args(); $a++ )
 189                 $args[] = func_get_arg( $a );
 190
 191         yourls_apply_filter( $hook, $args );
 192 }
 193
 194 /**
 195 * Retrieve the number times an action is fired.
 196 *
 197 * @param string $hook Name of the action hook.
 198 * @return int The number of times action hook <tt>$hook</tt> is fired
 199 */
 200 function yourls_did_action( $hook ) {
 201         global $yourls_actions;
 202         if ( !isset( $yourls_actions ) || !isset( $yourls_actions[ $hook ] ) )
 203                 return 0;
 204         return $yourls_actions[ $hook ];
 205 }
 206
 207 /**
 208  * Removes a function from a specified filter hook.
 209  *
 210  * This function removes a function attached to a specified filter hook. This
 211  * method can be used to remove default functions attached to a specific filter
 212  * hook and possibly replace them with a substitute.
 213  *
 214  * To remove a hook, the $function_to_remove and $priority arguments must match
 215  * when the hook was added.
 216  *
 217  * @global array $yourls_filters storage for all of the filters
 218  * @param string $hook The filter hook to which the function to be removed is hooked.
 219  * @param callback $function_to_remove The name of the function which should be removed.
 220  * @param int $priority optional. The priority of the function (default: 10).
 221  * @return boolean Whether the function was registered as a filter before it was removed.
 222  */
 223 function yourls_remove_filter( $hook, $function_to_remove, $priority = 10 ) {
 224         global $yourls_filters;
 225
 226         $function_to_remove = yourls_filter_unique_id( $hook, $function_to_remove, $priority );
 227
 228         $remove = isset( $yourls_filters[ $hook ][ $priority ][ $function_to_remove ] );
 229
 230         if ( $remove === true ) {
 231                 unset ( $yourls_filters[$hook][$priority][$function_to_remove] );
 232                 if ( empty( $yourls_filters[$hook][$priority] ) )
 233                         unset( $yourls_filters[$hook] );
 234         }
 235         return $remove;
 236 }
 237
 238 /**
 239  * Removes a function from a specified action hook.
 240  *
 241  * @see yourls_remove_filter()
 242  *
 243  * @param string $hook The action hook to which the function to be removed is hooked.
 244  * @param callback $function_to_remove The name of the function which should be removed.
 245  * @param int $priority optional. The priority of the function (default: 10).
 246  * @return boolean Whether the function was registered as an action before it was removed.
 247  */
 248
 249 function yourls_remove_action( $hook, $function_to_remove, $priority = 10 ) {
 250     return yourls_remove_filter( $hook, $function_to_remove, $priority );
 251 }
 252
 253 /**
 254  * Check if any filter has been registered for a hook.
 255  *
 256  * @global array $yourls_filters storage for all of the filters
 257  * @param string $hook The name of the filter hook.
 258  * @param callback $function_to_check optional.  If specified, return the priority of that function on this hook or false if not attached.
 259  * @return int|boolean Optionally returns the priority on that hook for the specified function.
 260  */
 261 function yourls_has_filter( $hook, $function_to_check = false ) {
 262         global $yourls_filters;
 263
 264         $has = !empty( $yourls_filters[ $hook ] );
 265         if ( false === $function_to_check || false == $has ) {
 266                 return $has;
 267         }
 268         if ( !$idx = yourls_filter_unique_id( $hook, $function_to_check, false ) ) {
 269                 return false;
 270         }
 271
 272         foreach ( (array) array_keys( $yourls_filters[ $hook ] ) as $priority ) {
 273                 if ( isset( $yourls_filters[ $hook ][ $priority ][ $idx ] ) )
 274                         return $priority;
 275         }
 276         return false;
 277 }
 278
 279 function yourls_has_action( $hook, $function_to_check = false ) {
 280         return yourls_has_filter( $hook, $function_to_check );
 281 }
 282
 283 /**
 284  * Return number of active plugins
 285  *
 286  * @return integer Number of activated plugins
 287  */
 288 function yourls_has_active_plugins( ) {
 289         global $ydb;
 290
 291         if( !property_exists( $ydb, 'plugins' ) || !$ydb->plugins )
 292                 $ydb->plugins = array();
 293
 294         return count( $ydb->plugins );
 295 }
 296
 297
 298 /**
 299  * List plugins in /user/plugins
 300  *
 301  * @return array Array of [/plugindir/plugin.php]=>array('Name'=>'Ozh', 'Title'=>'Hello', )
 302  */
 303 function yourls_get_plugins( ) {
 304         $plugins = (array) glob( YOURLS_PLUGINDIR .'/*/plugin.php');
 305
 306         if( !$plugins )
 307                 return array();
 308
 309         foreach( $plugins as $key => $plugin ) {
 310                 $_plugin = yourls_plugin_basename( $plugin );
 311                 $plugins[ $_plugin ] = yourls_get_plugin_data( $plugin );
 312                 unset( $plugins[ $key ] );
 313         }
 314
 315         return $plugins;
 316 }
 317
 318 /**
 319  * Check if a plugin is active
 320  *
 321  * @param string $plugin Physical path to plugin file
 322  * @return bool
 323  */
 324 function yourls_is_active_plugin( $plugin ) {
 325         if( !yourls_has_active_plugins( ) )
 326                 return false;
 327
 328         global $ydb;
 329         $plugin = yourls_plugin_basename( $plugin );
 330
 331         return in_array( $plugin, $ydb->plugins );
 332
 333 }
 334
 335 /**
 336  * Parse a plugin header
 337  *
 338  * @param string $file Physical path to plugin file
 339  * @return array Array of 'Field'=>'Value' from plugin comment header lines of the form "Field: Value"
 340  */
 341 function yourls_get_plugin_data( $file ) {
 342         $fp = fopen( $file, 'r' ); // assuming $file is readable, since yourls_load_plugins() filters this
 343         $data = fread( $fp, 8192 ); // get first 8kb
 344         fclose( $fp );
 345
 346         // Capture all the header within first comment block
 347         if( !preg_match( '!.*?/\*(.*?)\*/!ms', $data, $matches ) )
 348                 return array();
 349
 350         // Capture each line with "Something: some text"
 351         unset( $data );
 352         $lines = preg_split( "[\n|\r]", $matches[1] );
 353         unset( $matches );
 354
 355         $plugin_data = array();
 356         foreach( $lines as $line ) {
 357                 if( !preg_match( '!(.*?):\s+(.*)!', $line, $matches ) )
 358                         continue;
 359
 360                 list( $null, $field, $value ) = array_map( 'trim', $matches);
 361                 $plugin_data[ $field ] = $value;
 362         }
 363
 364         return $plugin_data;
 365 }
 366
 367 // Include active plugins
 368 function yourls_load_plugins() {
 369         // Don't load plugins when installing or updating
 370         if( yourls_is_installing() OR yourls_is_upgrading() )
 371                 return;
 372
 373         $active_plugins = yourls_get_option( 'active_plugins' );
 374         if( false === $active_plugins )
 375                 return;
 376
 377         global $ydb;
 378         $ydb->plugins = array();
 379
 380         foreach( (array)$active_plugins as $key=>$plugin ) {
 381                 if( yourls_validate_plugin_file( YOURLS_PLUGINDIR.'/'.$plugin ) ) {
 382                         include_once( YOURLS_PLUGINDIR.'/'.$plugin );
 383                         $ydb->plugins[] = $plugin;
 384                         unset( $active_plugins[$key] );
 385                 }
 386         }
 387
 388         // $active_plugins should be empty now, if not, a plugin could not be find: remove it
 389         if( count( $active_plugins ) ) {
 390                 yourls_update_option( 'active_plugins', $ydb->plugins );
 391                 $message = yourls_n( 'Could not find and deactivated plugin :', 'Could not find and deactivated plugins :', count( $active_plugins ) );
 392                 $missing = '<strong>'.join( '</strong>, <strong>', $active_plugins ).'</strong>';
 393                 yourls_add_notice( $message .' '. $missing );
 394         }
 395 }
 396
 397 /**
 398  * Check if a file is safe for inclusion (well, "safe", no guarantee)
 399  *
 400  * @param string $file Full pathname to a file
 401  * @return bool
 402  */
 403 function yourls_validate_plugin_file( $file ) {
 404         if (
 405                 false !== strpos( $file, '..' )
 406                 OR
 407                 false !== strpos( $file, './' )
 408                 OR
 409                 'plugin.php' !== substr( $file, -10 )   // a plugin must be named 'plugin.php'
 410                 OR
 411                 !is_readable( $file )
 412         )
 413                 return false;
 414
 415         return true;
 416 }
 417
 418 /**
 419  * Activate a plugin
 420  *
 421  * @param string $plugin Plugin filename (full or relative to plugins directory)
 422  * @return mixed string if error or true if success
 423  */
 424 function yourls_activate_plugin( $plugin ) {
 425         // validate file
 426         $plugin = yourls_plugin_basename( $plugin );
 427         $plugindir = yourls_sanitize_filename( YOURLS_PLUGINDIR );
 428         if( !yourls_validate_plugin_file( $plugindir.'/'.$plugin ) )
 429                 return yourls__( 'Not a valid plugin file' );
 430
 431         // check not activated already
 432         global $ydb;
 433         if( yourls_has_active_plugins() && in_array( $plugin, $ydb->plugins ) )
 434                 return yourls__( 'Plugin already activated' );
 435
 436         // attempt activation. TODO: uber cool fail proof sandbox like in WP.
 437         ob_start();
 438         include_once( YOURLS_PLUGINDIR.'/'.$plugin );
 439         if ( ob_get_length() > 0 ) {
 440                 // there was some output: error
 441                 $output = ob_get_clean();
 442                 return yourls_s( 'Plugin generated unexpected output. Error was: <br/><pre>%s</pre>', $output );
 443         }
 444     ob_end_clean();
 445
 446         // so far, so good: update active plugin list
 447         $ydb->plugins[] = $plugin;
 448         yourls_update_option( 'active_plugins', $ydb->plugins );
 449         yourls_do_action( 'activated_plugin', $plugin );
 450         yourls_do_action( 'activated_' . $plugin );
 451
 452         return true;
 453 }
 454
 455 /**
 456  * Deactivate a plugin
 457  *
 458  * @param string $plugin Plugin filename (full relative to plugins directory)
 459  * @return mixed string if error or true if success
 460  */
 461 function yourls_deactivate_plugin( $plugin ) {
 462         $plugin = yourls_plugin_basename( $plugin );
 463
 464         // Check plugin is active
 465         if( !yourls_is_active_plugin( $plugin ) )
 466                 return yourls__( 'Plugin not active' );
 467
 468         // Deactivate the plugin
 469         global $ydb;
 470         $key = array_search( $plugin, $ydb->plugins );
 471         if( $key !== false ) {
 472                 array_splice( $ydb->plugins, $key, 1 );
 473         }
 474
 475         yourls_update_option( 'active_plugins', $ydb->plugins );
 476         yourls_do_action( 'deactivated_plugin', $plugin );
 477         yourls_do_action( 'deactivated_' . $plugin );
 478
 479         return true;
 480 }
 481
 482 /**
 483  * Return the path of a plugin file, relative to the plugins directory
 484  */
 485 function yourls_plugin_basename( $file ) {
 486         $file = yourls_sanitize_filename( $file );
 487         $plugindir = yourls_sanitize_filename( YOURLS_PLUGINDIR );
 488         $file = str_replace( $plugindir, '', $file );
 489         return trim( $file, '/' );
 490 }
 491
 492 /**
 493  * Return the URL of the directory a plugin
 494  */
 495 function yourls_plugin_url( $file ) {
 496         $url = YOURLS_PLUGINURL . '/' . yourls_plugin_basename( $file );
 497         if( yourls_is_ssl() or yourls_needs_ssl() )
 498                 $url = str_replace( 'http://', 'https://', $url );
 499         return yourls_apply_filter( 'plugin_url', $url, $file );
 500 }
 501
 502 /**
 503  * Display list of links to plugin admin pages, if any
 504  */
 505 function yourls_list_plugin_admin_pages() {
 506         global $ydb;
 507
 508         if( !property_exists( $ydb, 'plugin_pages' ) || !$ydb->plugin_pages )
 509                 return;
 510
 511         $plugin_links = array();
 512         foreach( (array)$ydb->plugin_pages as $plugin => $page ) {
 513                 $plugin_links[ $plugin ] = array(
 514                         'url'    => yourls_admin_url( 'plugins.php?page='.$page['slug'] ),
 515                         'anchor' => $page['title'],
 516                 );
 517         }
 518         return $plugin_links;
 519 }
 520
 521 /**
 522  * Register a plugin administration page
 523  */
 524 function yourls_register_plugin_page( $slug, $title, $function ) {
 525         global $ydb;
 526
 527         if( !property_exists( $ydb, 'plugin_pages' ) || !$ydb->plugin_pages )
 528                 $ydb->plugin_pages = array();
 529
 530         $ydb->plugin_pages[ $slug ] = array(
 531                 'slug'     => $slug,
 532                 'title'    => $title,
 533                 'function' => $function,
 534         );
 535 }
 536
 537 /**
 538  * Handle plugin administration page
 539  *
 540  */
 541 function yourls_plugin_admin_page( $plugin_page ) {
 542         global $ydb;
 543
 544         // Check the plugin page is actually registered
 545         if( !isset( $ydb->plugin_pages[$plugin_page] ) ) {
 546                 yourls_die( yourls__( 'This page does not exist. Maybe a plugin you thought was activated is inactive?' ), yourls__( 'Invalid link' ) );
 547         }
 548
 549         // Draw the page itself
 550         yourls_do_action( 'load-' . $plugin_page);
 551         yourls_html_head( 'plugin_page_' . $plugin_page, $ydb->plugin_pages[$plugin_page]['title'] );
 552         yourls_html_logo();
 553         yourls_html_menu();
 554
 555         call_user_func( $ydb->plugin_pages[$plugin_page]['function'] );
 556
 557         yourls_html_footer();
 558 }
 559
 560
 561 /**
 562  * Callback function: Sort plugins
 563  *
 564  * @link http://php.net/uasort
 565  *
 566  * @param array $plugin_a
 567  * @param array $plugin_b
 568  * @return int 0, 1 or -1, see uasort()
 569  */
 570 function yourls_plugins_sort_callback( $plugin_a, $plugin_b ) {
 571         $orderby = yourls_apply_filter( 'plugins_sort_callback', 'Plugin Name' );
 572         $order   = yourls_apply_filter( 'plugins_sort_callback', 'ASC' );
 573
 574         $a = isset( $plugin_a[ $orderby ] ) ? $plugin_a[ $orderby ] : '';
 575         $b = isset( $plugin_b[ $orderby ] ) ? $plugin_b[ $orderby ] : '';
 576
 577         if ( $a == $b )
 578                 return 0;
 579
 580         if ( 'DESC' == $order )
 581                 return ( $a < $b ) ? 1 : -1;
 582         else
 583                 return ( $a < $b ) ? -1 : 1;
 584 }