CS fixes

Aleksander Machniak

2012-12-21 c4781306a54006727b05a5b8a5414e09c51b8bef

 program/lib/Roundcube/rcube_plugin_api.php

@@ -3,7 +3,7 @@
/*
 +-----------------------------------------------------------------------+
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2008-2011, The Roundcube Dev Team                       |
 | Copyright (C) 2008-2012, The Roundcube Dev Team                       |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
@@ -17,9 +17,9 @@
*/

// location where plugins are loade from
if (!defined('RCUBE_PLUGINS_DIR'))
if (!defined('RCUBE_PLUGINS_DIR')) {
  define('RCUBE_PLUGINS_DIR', RCUBE_INSTALL_PATH . 'plugins/');

}

/**
 * The plugin loader and global API
@@ -35,8 +35,8 @@
  public $url = 'plugins/';
  public $task = '';
  public $output;

  public $handlers = array();

  protected $plugins = array();
  protected $tasks = array();
  protected $actions = array();
@@ -93,7 +93,6 @@
    return self::$instance;
  }


  /**
   * Private constructor
   */
@@ -101,7 +100,6 @@
  {
    $this->dir = slashify(RCUBE_PLUGINS_DIR);
  }


  /**
   * Initialize plugin engine
@@ -120,9 +118,9 @@
    // register an internal hook
    $this->register_hook('template_container', array($this, 'template_container_hook'));

    // maybe also register a shudown function which triggers shutdown functions of all plugin objects
        // maybe also register a shudown function which triggers
        // shutdown functions of all plugin objects
  }


  /**
   * Load and init all enabled plugins
@@ -150,12 +148,14 @@
      }

      // load required core plugin if no derivate was found
      if (!$loaded)
            if (!$loaded) {
        $loaded = $this->load_plugin($plugin_name);
            }

      // trigger fatal error if still not loaded
      if (!$loaded) {
        rcube::raise_error(array('code' => 520, 'type' => 'php',
                rcube::raise_error(array(
                    'code' => 520, 'type' => 'php',
          'file' => __FILE__, 'line' => __LINE__,
          'message' => "Requried plugin $plugin_name was not loaded"), true, true);
      }
@@ -166,6 +166,7 @@
   * Load the specified plugin
   *
   * @param string Plugin name
     *
   * @return boolean True on success, false if not loaded or failure
   */
  public function load_plugin($plugin_name)
@@ -178,13 +179,15 @@
    }

    // plugin already loaded
    if ($this->plugins[$plugin_name] || class_exists($plugin_name, false))
        if ($this->plugins[$plugin_name] || class_exists($plugin_name, false)) {
      return true;
        }

    $fn = $plugins_dir . DIRECTORY_SEPARATOR . $plugin_name . DIRECTORY_SEPARATOR . $plugin_name . '.php';
        $fn = $plugins_dir . DIRECTORY_SEPARATOR . $plugin_name
            . DIRECTORY_SEPARATOR . $plugin_name . '.php';

    if (file_exists($fn)) {
      include($fn);
            include $fn;

      // instantiate class if exists
      if (class_exists($plugin_name, false)) {
@@ -205,7 +208,8 @@
      else {
        rcube::raise_error(array('code' => 520, 'type' => 'php',
          'file' => __FILE__, 'line' => __LINE__,
          'message' => "No plugin class $plugin_name found in $fn"), true, false);
                    'message' => "No plugin class $plugin_name found in $fn"),
                    true, false);
      }
    }
    else {
@@ -216,7 +220,6 @@

    return false;
  }


  /**
   * Allows a plugin object to register a callback for a certain hook
@@ -230,15 +233,17 @@
      if (isset($this->deprecated_hooks[$hook])) {
        rcube::raise_error(array('code' => 522, 'type' => 'php',
          'file' => __FILE__, 'line' => __LINE__,
          'message' => "Deprecated hook name. ".$hook.' -> '.$this->deprecated_hooks[$hook]), true, false);
                    'message' => "Deprecated hook name. "
                        . $hook . ' -> ' . $this->deprecated_hooks[$hook]), true, false);
        $hook = $this->deprecated_hooks[$hook];
      }
      $this->handlers[$hook][] = $callback;
    }
    else
        else {
      rcube::raise_error(array('code' => 521, 'type' => 'php',
        'file' => __FILE__, 'line' => __LINE__,
        'message' => "Invalid callback function for $hook"), true, false);
        }
  }

  /**
@@ -255,36 +260,38 @@
    }
  }


  /**
   * Triggers a plugin hook.
   * This is called from the application and executes all registered handlers
   *
   * @param string $hook Hook name
   * @param array $args Named arguments (key->value pairs)
     *
   * @return array The (probably) altered hook arguments
   */
  public function exec_hook($hook, $args = array())
  {
    if (!is_array($args))
        if (!is_array($args)) {
      $args = array('arg' => $args);
        }

    $args += array('abort' => false);
    $this->active_hook = $hook;

    foreach ((array)$this->handlers[$hook] as $callback) {
      $ret = call_user_func($callback, $args);
      if ($ret && is_array($ret))
            if ($ret && is_array($ret)) {
        $args = $ret + $args;
            }

      if ($args['abort'])
            if ($args['abort']) {
        break;
            }
    }

    $this->active_hook = false;
    return $args;
  }


  /**
   * Let a plugin register a handler for a specific request
@@ -310,10 +317,10 @@
    else {
      rcube::raise_error(array('code' => 523, 'type' => 'php',
        'file' => __FILE__, 'line' => __LINE__,
        'message' => "Cannot register action $action; already taken by another plugin"), true, false);
                'message' => "Cannot register action $action;"
                    ." already taken by another plugin"), true, false);
    }
  }


  /**
   * This method handles requests like _task=mail&_action=plugin.foo
@@ -333,7 +340,6 @@
    }
  }


  /**
   * Register a handler function for template objects
   *
@@ -344,21 +350,24 @@
  public function register_handler($name, $owner, $callback)
  {
    // check name
    if (strpos($name, 'plugin.') !== 0)
        if (strpos($name, 'plugin.') !== 0) {
      $name = 'plugin.'.$name;
        }

    // can register handler only if it's not taken or registered by myself
    if (is_object($this->output) && (!isset($this->objectsmap[$name]) || $this->objectsmap[$name] == $owner)) {
        if (is_object($this->output)
            && (!isset($this->objectsmap[$name]) || $this->objectsmap[$name] == $owner)
        ) {
      $this->output->add_handler($name, $callback);
      $this->objectsmap[$name] = $owner;
    }
    else {
      rcube::raise_error(array('code' => 525, 'type' => 'php',
        'file' => __FILE__, 'line' => __LINE__,
        'message' => "Cannot register template handler $name; already taken by another plugin or no output object available"), true, false);
                'message' => "Cannot register template handler $name;"
                    ." already taken by another plugin or no output object available"), true, false);
    }
  }


  /**
   * Register this plugin to be responsible for a specific task
@@ -369,18 +378,21 @@
  public function register_task($task, $owner)
  {
    // tasks are irrelevant in framework mode
    if (!class_exists('rcmail', false))
        if (!class_exists('rcmail', false)) {
      return true;
        }

    if ($task != asciiwords($task)) {
      rcube::raise_error(array('code' => 526, 'type' => 'php',
        'file' => __FILE__, 'line' => __LINE__,
        'message' => "Invalid task name: $task. Only characters [a-z0-9_.-] are allowed"), true, false);
                'message' => "Invalid task name: $task."
                    ." Only characters [a-z0-9_.-] are allowed"), true, false);
    }
    else if (in_array($task, rcmail::$main_tasks)) {
      rcube::raise_error(array('code' => 526, 'type' => 'php',
        'file' => __FILE__, 'line' => __LINE__,
        'message' => "Cannot register taks $task; already taken by another plugin or the application itself"), true, false);
                'message' => "Cannot register taks $task;"
                    ." already taken by another plugin or the application itself"), true, false);
    }
    else {
      $this->tasks[$task] = $owner;
@@ -391,11 +403,11 @@
    return false;
  }


  /**
   * Checks whether the given task is registered by a plugin
   *
   * @param string $task Task name
     *
   * @return boolean True if registered, otherwise false
   */
  public function is_plugin_task($task)
@@ -403,12 +415,12 @@
    return $this->tasks[$task] ? true : false;
  }


  /**
   * Check if a plugin hook is currently processing.
   * Mainly used to prevent loops and recursion.
   *
   * @param string $hook Hook to check (optional)
     *
   * @return boolean True if any/the given hook is currently processed, otherwise false
   */
  public function is_processing($hook = null)
@@ -425,10 +437,10 @@
  {
    if (is_object($this->output) && $this->output->type == 'html') {
      $src = $this->resource_url($fn);
      $this->output->add_header(html::tag('script', array('type' => "text/javascript", 'src' => $src)));
            $this->output->add_header(html::tag('script',
                array('type' => "text/javascript", 'src' => $src)));
    }
  }


  /**
   * Include a plugin stylesheet in the current HTML page
@@ -443,7 +455,6 @@
    }
  }


  /**
   * Save the given HTML content to be added to a template container
   *
@@ -455,7 +466,6 @@
    $this->template_contents[$container] .= $html . "\n";
  }


  /**
   * Returns list of loaded plugins names
   *
@@ -465,7 +475,6 @@
  {
    return array_keys($this->plugins);
  }


  /**
   * Callback for template_container hooks
@@ -478,7 +487,6 @@
    $container = $attrib['name'];
    return array('content' => $attrib['content'] . $this->template_contents[$container]);
  }


  /**
   * Make the given file name link into the plugins directory
@@ -493,5 +501,4 @@
    else
      return $fn;
  }

}