Changeset 2287 in subversion

Timestamp:

Feb 10, 2009 6:14:03 PM (4 years ago)

Author:

thomasb

Message:

Init plugins AFTER output object was created + make localized texts available on the client

Location:

branches/devel-api

Files:

• index.php (modified) (2 diffs)
• plugins/markasjunk/localization (added)
• plugins/markasjunk/localization/en_US.inc (added)
• plugins/markasjunk/markasjunk.js (modified) (1 diff)
• plugins/markasjunk/markasjunk.php (modified) (2 diffs)
• plugins/userinfo/localization/de_CH.inc (modified) (1 diff)
• plugins/userinfo/localization/en_US.inc (modified) (1 diff)
• plugins/userinfo/userinfo.js (modified) (1 diff)
• plugins/userinfo/userinfo.php (modified) (1 diff)
• program/include/rcmail.php (modified) (1 diff)
• program/include/rcube_plugin.php (modified) (4 diffs)
• program/include/rcube_plugin_api.php (modified) (6 diffs)
• program/include/rcube_template.php (modified) (1 diff)
• program/js/app.js (modified) (1 diff)

branches/devel-api/index.php

@@ -3 +3 @@
  +-------------------------------------------------------------------------+
  | RoundCube Webmail IMAP Client                                           |
- | Version 0.3-20090201                                                    |
+ | Version 0.3-20090210                                                    |
  |                                                                         |
  | Copyright (C) 2005-2009, RoundCube Dev. - Switzerland                   |
@@ -36 +36 @@
 // init output class
 $OUTPUT = !empty($_REQUEST['_remote']) ? $RCMAIL->init_json() : $RCMAIL->load_gui(!empty($_REQUEST['_framed']));
+
+// init plugin API
+$RCMAIL->plugins->init();
 
 // set output buffering

branches/devel-api/plugins/markasjunk/markasjunk.js

@@ -17 +17 @@
     
     // create button
-    var button = $('<A>').html('<img src="plugins/markasjunk/junk_pas.png" id="rcmButtonMarkAsJunk" width="32" height="32" alt="" title="" />').css('cursor', 'pointer');
+    var button = $('<A>').html('<img src="plugins/markasjunk/junk_pas.png" id="rcmButtonMarkAsJunk" width="32" height="32" alt="" title="'+rcmail.gettext('buttontitle', 'markasjunk')+'" />').css('cursor', 'pointer');
     button.bind('click', function(e){ return rcmail.command('plugin.markasjunk', this) });
     

branches/devel-api/plugins/markasjunk/markasjunk.php

@@ -15 +15 @@
     
     $rcmail = rcmail::get_instance();
-    if ($rcmail->action == '' || $rcmail->action == 'show')
+    if ($rcmail->action == '' || $rcmail->action == 'show') {
       $this->include_script('markasjunk.js');
+      $this->add_texts('localization', true);
+    }
   }
 
   function request_action()
   {
-    $rcmail = rcmail::get_instance();
+    $this->add_texts('localization');
     
-    $count = sizeof(explode(',', ($uids = get_input_value('_uid', RCUBE_INPUT_POST))));
+    $uids = get_input_value('_uid', RCUBE_INPUT_POST);
     $mbox = get_input_value('_mbox', RCUBE_INPUT_POST);
     
+    $rcmail = rcmail::get_instance();
     $rcmail->imap->set_flag($uids, 'JUNK');
     
@@ -32 +35 @@
     }
     
-    $rcmail->output->show_message('reportedasspam', 'confirmation');
+    $rcmail->output->command('display_message', $this->gettext('reportedasjunk'), 'confirmation');
     $rcmail->output->send();
   }

branches/devel-api/plugins/userinfo/localization/de_CH.inc

@@ -2 +2 @@
 
 $labels = array();
+$labels['userinfo'] = 'Benutzerinfo';
 $labels['created'] = 'Erstellt';
 $labels['lastlogin'] = 'Letztes Login';

branches/devel-api/plugins/userinfo/localization/en_US.inc

@@ -2 +2 @@
 
 $labels = array();
+$labels['userinfo'] = 'User info';
 $labels['created'] = 'Created';
 $labels['lastlogin'] = 'Last Login';

branches/devel-api/plugins/userinfo/userinfo.js

@@ -6 +6 @@
     var tab = $('<span>').attr('id', 'settingstabpluginuserinfo').addClass('tablink');
     
-    var button = $('<a>').attr('href', rcmail.env.comm_path+'&_action=plugin.userinfo').html('Userinfo').appendTo(tab);
+    var button = $('<a>').attr('href', rcmail.env.comm_path+'&_action=plugin.userinfo').html(rcmail.gettext('userinfo', 'userinfo')).appendTo(tab);
     button.bind('click', function(e){ return rcmail.command('plugin.userinfo', this) });
     

branches/devel-api/plugins/userinfo/userinfo.php

@@ -11 +11 @@
   function init()
   {
-    $this->add_texts('localization/');
+    $this->add_texts('localization/', array('userinfo'));
     $this->register_action('plugin.userinfo', array($this, 'infostep'));
     $this->include_script('userinfo.js');

branches/devel-api/program/include/rcmail.php

@@ -320 +320 @@
     $this->output->add_label('loading');
     
-    // load plugins stuff
-    $this->plugins->init_gui($this->output);
-    
     return $this->output;
   }

branches/devel-api/program/include/rcube_plugin.php

@@ -62 +62 @@
    *
    * @param string Directory to search in
-   * @param string Domain to save texts
+   * @param mixed Make texts also available on the client (array with list or true for all)
    */
-  public function add_texts($dir)
+  public function add_texts($dir, $add2client = false)
   {
-    if (empty($domain))
-      $domain = $this->ID;
+    $domain = $this->ID;
     
     $lang = $_SESSION['language'];
@@ -86 +85 @@
       $rcmail = rcmail::get_instance();
       $rcmail->load_language($lang, $add);
+      
+      // add labels to client
+      if ($add2client) {
+        $js_labels = is_array($add2client) ? array_map(array($this, 'label_map_callback'), $add2client) : array_keys($add);
+        $rcmail->output->add_label($js_labels);
+      }
     }
   }
@@ -91 +96 @@
   /**
    * Wrapper for rcmail::gettext() adding the plugin ID as domain
+   *
+   * @return string Localized text
+   * @see rcmail::gettext()
    */
   function gettext($p)
@@ -155 +163 @@
   }
 
+  /**
+   * Callback function for array_map
+   */
+  private function label_map_callback($key)
+  {
+    return $this->ID.'.'.$key;
+  }
+
 
 }

branches/devel-api/program/include/rcube_plugin_api.php

@@ -36 +36 @@
   private $actions = array();
   private $actionmap = array();
-  private $templobjects = array();
   private $objectsmap = array();
-  private $scripts = array();
-  private $stylesheets = array();
   private $output;
   
@@ -70 +67 @@
     
     $this->dir = realpath($rcmail->config->get('plugins_dir'));
-    
-    // load all enabled plugins
+  }
+  
+  
+  /**
+   * Load and init all enabled plugins
+   *
+   * This has to be done after rcmail::load_gui() or rcmail::init_json()
+   * was called because plugins need to have access to rcmail->output
+   */
+  public function init()
+  {
+    $rcmail = rcmail::get_instance();
+    $this->output = $rcmail->output;
+    
     $plugins_dir = dir($this->dir);
     $plugins_enabled = (array)$rcmail->config->get('plugins', array());
@@ -104 +113 @@
   
   /**
-   * Add GUI things once the output objects is created
-   */
-  public function init_gui($output)
-  {
-    if ($output->type == 'html') {
-      $output->add_handlers($this->objectsmap);
-      
-      foreach ($this->stylesheets as $css)
-        $output->add_header(html::tag('link', array('rel' => "stylesheet", 'type' => "text/css", 'href' => $css)));
-      
-      foreach ($this->scripts as $script)
-        $output->add_header(html::tag('script', array('type' => "text/javascript", 'src' => $script)));
-    }
-    
-    $this->output = $output;
-  }
-  
-  
-  /**
    * Allows a plugin object to register a callback for a certain hook
    *
@@ -218 +208 @@
     // can register handler only if it's not taken or registered by myself
     if (!isset($this->objectsmap[$name]) || $this->objectsmap[$name] == $owner) {
-      // output is ready
-      if ($this->output) {
-        $this->output->add_handler($name, $callback);
-      }
-      else {
-        $this->templobjects[$name] = $callback;
-        $this->objectsmap[$name] = $owner;
-      }
+      $this->output->add_handler($name, $callback);
+      $this->objectsmap[$name] = $owner;
     }
     else {
@@ -237 +221 @@
   public function include_script($fn)
   {
-    $src = $this->ressource_url($fn);
-    
-    if ($this->output)
+    if ($this->output->type == 'html') {
+      $src = $this->ressource_url($fn);
       $this->output->add_header(html::tag('script', array('type' => "text/javascript", 'src' => $src)));
-    else
-      $this->scripts[] = $src;
+    }
   }
 
@@ -250 +232 @@
   public function include_stylesheet($fn)
   {
-    $src = $this->ressource_url($fn);
-    
-    if ($this->output)
+    if ($this->output->type == 'html') {
+      $src = $this->ressource_url($fn);
       $this->output->add_header(html::tag('link', array('rel' => "stylesheet", 'type' => "text/css", 'href' => $src)));
-    else
-      $this->stylesheets[] = $src;
+    }
   }
   

branches/devel-api/program/include/rcube_template.php

@@ -210 +210 @@
     public function add_label()
     {
-        $arg_list = func_get_args();
-        foreach ($arg_list as $i => $name) {
+        $args = func_get_args();
+        if (count($args) == 1 && is_array($args[0]))
+          $args = $args[0];
+        
+        foreach ($args as $name) {
             $this->command('add_label', $name, rcube_label($name));
         }

branches/devel-api/program/js/app.js

@@ -1159 +1159 @@
 
   // return a localized string
-  this.get_label = function(name)
-    {
-    if (this.labels[name])
+  this.get_label = function(name, domain)
+    {
+    if (domain && this.labels[domain+'.'+name])
+      return this.labels[domain+'.'+name];
+    else if (this.labels[name])
       return this.labels[name];
     else
       return name;
     };
+  
+  // alias for convenience reasons
+  this.gettext = this.get_label;
 
   // switch to another application task