Changeset 3333:11107ba2fc59

Timestamp:

09/01/16 12:21:43 (9 years ago)

Author:

franck <carnet.franck.paul@…>

Branch:

default

Message:

Cope with settings URLs for modules (defined in _define.php).
The settings URLs are displayed on the plugins maganement page, and at the bottom of each plugin main page if any (index.php).

The URLs are set in _define.php, as a new property using this schema:

'settings' => array( <list of URLs> )

With:

<list of URLs> = '<type>' => '<location>', …
<type> = 'self' (own plugin page), 'blog' (in blog parameters page) or 'pref' (in user preferences page)
<location> = (empty) or #<tab>[.<id>] with <tab> = id of the corresponding tab, and <id> = id of fieldset, h4, h5, field, … of first corresponding field

The list of URLs are displayed in the order defined in the array above.

Examples:

Antispam plugin:

'settings' => array(

'self' => ,
'blog' => '#params.antispam_params'

)

self → for main settings of the plugin on its own page (index.php)
blog → for secondary settings in the blog parameters

Tags plugin:

'settings' => array(

'pref' => '#user-options.tags_prefs'

)

pref → for tags list format in user preferences

Maintenance plugin:

'settings' => array(

'self' => '#settings'

)

self → "settings" tab of its own page (index.php)

Files:

• admin/js/jquery/jquery.pageTabs.js (modified) (8 diffs)
• admin/plugin.php (modified) (1 diff)
• admin/preferences.php (modified) (3 diffs)
• inc/admin/lib.moduleslist.php (modified) (4 diffs)
• inc/core/class.dc.modules.php (modified) (2 diffs)
• locales/fr/main.po (modified) (1 diff)
• plugins/antispam/_admin.php (modified) (1 diff)
• plugins/antispam/_define.php (modified) (1 diff)
• plugins/breadcrumb/_admin.php (modified) (1 diff)
• plugins/breadcrumb/_define.php (modified) (1 diff)
• plugins/dcCKEditor/_define.php (modified) (1 diff)
• plugins/dcLegacyEditor/_define.php (modified) (1 diff)
• plugins/maintenance/_define.php (modified) (1 diff)
• plugins/pings/_define.php (modified) (1 diff)
• plugins/simpleMenu/_define.php (modified) (1 diff)
• plugins/tags/_define.php (modified) (1 diff)
• plugins/tags/inc/tags.behaviors.php (modified) (1 diff)
• plugins/themeEditor/_admin.php (modified) (1 diff)
• plugins/themeEditor/_define.php (modified) (1 diff)

admin/js/jquery/jquery.pageTabs.js

@@ -1 +1 @@
 (function($) {
      'use strict';
-    
+
      $.pageTabs = function(start_tab, opts) {
           var defaults = {
@@ -10 +10 @@
                idTabPrefix: 'part-tabs-'
           };
-          
+
           $.pageTabs.options = $.extend({}, defaults, opts);
           var active_tab = start_tab || '';
           var hash = $.pageTabs.getLocationHash();
+          var subhash = $.pageTabs.getLocationSubhash();
 
           if (hash !== undefined && hash) {
@@ -23 +24 @@
 
           createTabs();
-          
+
           $('ul li', '.'+$.pageTabs.options.containerClass).click(function(e) {
                if ($(this).hasClass($.pageTabs.options.activeClass)) {
@@ -40 +41 @@
                     part_to_activate.addClass('loaded');
                }
-               
+
                part_to_activate.tabload();
           });
@@ -49 +50 @@
 
           $.pageTabs.clickTab(active_tab);
-          
+
+          if (subhash !== undefined) {
+               // Tab displayed, now scroll to the sub-part if defined in original document.location (#tab.sub-part)
+               document.getElementById(subhash).scrollIntoView();
+          }
+
           return this;
      };
-     
+
      var createTabs = function createTabs() {
           var lis = [], li_class = '';
-          
+
           $('.'+$.pageTabs.options.contentClass).each(function() {
                $(this).hide();
@@ -62 +68 @@
                $(this).attr('id', $.pageTabs.options.partPrefix + $(this).attr('id')).prop('title','');
           });
-          
+
           $('<div class="'+$.pageTabs.options.containerClass+'"><ul>'+lis.join('')+'</ul></div>')
                .insertBefore($('.'+$.pageTabs.options.contentClass).get(0));
      };
-     
+
      var getHash = function getHash(href) {
           var href = href || '';
@@ -72 +78 @@
           return href.replace(/.*#/, '');
      };
-     
+
      $.pageTabs.clickTab = function(tab) {
           if (tab=='') {
@@ -96 +102 @@
 
      $.pageTabs.getLocationHash = function() {
-          return getHash(document.location.hash);
+          // Return the URL hash (without subhash — #hash[.subhash])
+          var h = getHash(document.location.hash).split('.');
+          return h[0];
+     };
+     $.pageTabs.getLocationSubhash = function() {
+          // Return the URL subhash if present (without hash — #hash[.subhash])
+          var sh = getHash(document.location.hash).split('.');
+          return sh[1];
      };
 })(jQuery);

admin/plugin.php

@@ -78 +78 @@
      call_user_func($open_f,$p_title,$p_head);
      echo $p_content;
+     if (!$popup) {
+          // Add direct links to plugin settings if any
+          $settings = adminModulesList::getSettingsUrls($core,$p,true,false);
+          if (!empty($settings)) {
+               echo '<hr class="clear"/><p class="right modules">'.implode(' - ',$settings).'</p>';
+          }
+     }
      call_user_func($close_f);
 }

admin/preferences.php

@@ -490 +490 @@
 echo
 '<div class="fieldset">'.
-'<h4>'.__('Interface').'</h4>'.
+'<h4 id="user_options_interface">'.__('Interface').'</h4>'.
 
 '<p><label for="user_ui_enhanceduploader" class="classic">'.
@@ -524 +524 @@
 echo
 '<div class="fieldset">'.
-'<h4>'.__('Optional columns displayed in lists').'</h4>';
+'<h4 id="user_options_columns">'.__('Optional columns displayed in lists').'</h4>';
 $odd = true;
 foreach ($cols as $col_type => $col_list) {
@@ -541 +541 @@
 echo
 '<div class="fieldset">'.
-'<h4>'.__('Edition').'</h4>';
+'<h4 id="user_options_edition">'.__('Edition').'</h4>';
 
 echo '<div class="two-boxes odd">';

inc/admin/lib.moduleslist.php

@@ -466 +466 @@
                     'sshot'             => '',
                     'score'                  => 0,
-                    'type'                   => null
+                    'type'                   => null,
+                    'require'           => array(),
+                    'settings'               => array()
                ),
                # Module's values
@@ -744 +746 @@
                          if (!empty($more)) {
                               echo
-                              '<li>'.implode(' - ', $more).'</li>';
+                              '<li>'.implode(' - ',$more).'</li>';
                          }
 
@@ -753 +755 @@
                     $config = !empty($module['root']) && file_exists(path::real($module['root'].'/_config.php'));
 
-                    if ($config || !empty($module['section']) || !empty($module['tags'])) {
+                    if ($config || !empty($module['section']) || !empty($module['tags']) || !empty($module['settings'])) {
                          echo
                          '<div><ul class="mod-more">';
 
-                         if ($config) {
-                              echo
-                              '<li><a class="module-config" href="'.$this->getURL('module='.$id.'&amp;conf=1').'">'.__('Configure plugin').'</a></li>';
+                         $settings = $this->getSettingsUrls($this->core,$id);
+                         if (!empty($settings)) {
+                              echo '<li>'.implode(' - ',$settings).'</li>';
                          }
 
@@ -806 +808 @@
 
           return $this;
+     }
+
+     /**
+      * Get settings URLs if any
+      *
+      * @param object $core
+      * @param string $id module ID
+      * @param boolean $check check permission
+      * @param boolean $self include self URL (→ plugin index.php URL)
+      * @return Array of settings URLs
+      */
+     public static function getSettingsUrls($core,$id,$check=false,$self=true)
+     {
+          $st = array();
+
+          $config = !empty($core->plugins->moduleRoot($id)) &&
+               file_exists(path::real($core->plugins->moduleRoot($id).'/_config.php'));
+          $settings = $core->plugins->moduleInfo($id,'settings');
+          if ($config || !empty($settings)) {
+               if ($config) {
+                    $st[] = '<a class="module-config" href="'.
+                         $core->adminurl->get('admin.plugins',array('module' => $id,'conf' => '1')).
+                         '">'.__('Configure plugin').'</a>';
+               }
+               if (is_array($settings)) {
+                    foreach ($settings as $sk => $sv) {
+                         switch ($sk) {
+                              case 'blog':
+                                   if ((!$check) ||
+                                        ($check && $core->auth->check('admin',$core->blog->id))) {
+                                        $st[] = '<a class="module-config" href="'.
+                                             $core->adminurl->get('admin.blog.pref').$sv.
+                                             '">'.__('Plugin settings (in blog parameters)').'</a>';
+                                   }
+                                   break;
+                              case 'pref':
+                                   if ((!$check) ||
+                                        ($check && $core->auth->check('usage,contentadmin',$core->blog->id))) {
+                                        $st[] = '<a class="module-config" href="'.
+                                             $core->adminurl->get('admin.user.preferences').$sv.
+                                             '">'.__('Plugin settings (in user preferences)').'</a>';
+                                   }
+                                   break;
+                              case 'self':
+                                   if ($self) {
+                                        if ((!$check) ||
+                                             ($check && $core->auth->check($core->plugins->moduleInfo($id,'permissions'),$core->blog->id))) {
+                                             $st[] = '<a class="module-config" href="'.
+                                                  $core->adminurl->get('admin.plugin.'.$id).$sv.
+                                                  '">'.__('Plugin settings').'</a>';
+                                        }
+                                   }
+                                   break;
+                         }
+                    }
+               }
+          }
+
+          return $st;
      }
 

inc/core/class.dc.modules.php

@@ -283 +283 @@
      (currently available keys : permissions, priority, type)
      */
-     public function registerModule($name,$desc,$author,$version, $properties = array())
+     public function registerModule($name,$desc,$author,$version,$properties = array())
      {
           if ($this->disabled_mode) {
@@ -320 +320 @@
                     'type' => null,
                     'enabled' => true,
-                    'requires' => array()
+                    'requires' => array(),
+                    'settings' => array()
                ), $properties
           );

locales/fr/main.po

@@ -2979 +2979 @@
 msgstr "Configurer le plugin"
 
+msgid "Plugin settings (in blog parameters)"
+msgstr "Réglages du plugin (paramètres du blog)"
+
+msgid "Plugin settings (in user preferences)"
+msgstr "Réglages du plugin (mes préférences)"
+
+msgid "Plugin settings"
+msgstr "Réglages du plugin"
+
 msgid "No plugins matched your search."
 msgstr "Aucun plugin ne correspond à votre recherche."

plugins/antispam/_admin.php

@@ -91 +91 @@
           $ttl = $settings->antispam->antispam_moderation_ttl;
           echo
-          '<div class="fieldset"><h4>Antispam</h4>'.
+          '<div class="fieldset"><h4 id="antispam_params">Antispam</h4>'.
           '<p><label for="antispam_moderation_ttl" class="classic">'.__('Delete junk comments older than').' '.
           form::field('antispam_moderation_ttl', 3, 3, $ttl).

plugins/antispam/_define.php

@@ -19 +19 @@
      array(
           'permissions' =>    'usage,contentadmin',
-          'priority' =>       10
+          'priority' =>       10,
+          'settings'     =>        array(
+                                        'self' => '',
+                                        'blog' => '#params.antispam_params'
+                                   )
      )
 );

plugins/breadcrumb/_admin.php

@@ -25 +25 @@
           $settings->addNameSpace('breadcrumb');
           echo
-          '<div class="fieldset"><h4>'.__('Breadcrumb').'</h4>'.
+          '<div class="fieldset"><h4 id="breadcrumb_params">'.__('Breadcrumb').'</h4>'.
           '<p><label class="classic">'.
           form::checkbox('breadcrumb_enabled','1',$settings->breadcrumb->breadcrumb_enabled).

plugins/breadcrumb/_define.php

@@ -20 +20 @@
      array(
           /* Permissions */   'permissions' =>    'usage,contentadmin',
-          /* Type */               'type' =>           'plugin'
+          /* Type */               'type' =>           'plugin',
+          'settings'     =>        array(
+                                        'blog' => '#params.breadcrumb_params'
+                                   )
      )
 );

plugins/dcCKEditor/_define.php

@@ -19 +19 @@
      array(
           'permissions' =>    'usage,contentadmin',
-          'type'         =>        'plugin'
+          'type'         =>        'plugin',
+          'settings'     =>        array(
+                                        'self' => '',
+                                        'pref' => '#user-options.user_options_edition'
+                                   )
      )
 );

plugins/dcLegacyEditor/_define.php

@@ -19 +19 @@
      array(
           'permissions' =>    'usage,contentadmin',
-          'type'         =>        'plugin'
+          'type'         =>        'plugin',
+          'settings'     =>        array(
+                                        'self' => '',
+                                        'pref' => '#user-options.user_options_edition'
+                                   )
      )
 );

plugins/maintenance/_define.php

@@ -19 +19 @@
      array(
           'permissions' =>    'admin',
-          'type'         =>        'plugin'
+          'type'         =>        'plugin',
+          'settings'     =>        array(
+                                        'self' => '#settings'
+                                   )
      )
 

plugins/pings/_define.php

@@ -19 +19 @@
      array(
           'permissions' =>    'usage,contentadmin',
-          'type'         =>        'plugin'
+          'type'         =>        'plugin',
+          'settings'     =>        array(
+                                        'self' => ''
+                                   )
      )
 );

plugins/simpleMenu/_define.php

@@ -19 +19 @@
      array(
           'permissions' =>    'admin',
-          'type'         =>        'plugin'
+          'type'         =>        'plugin',
+          'settings'     =>        array(
+                                        'self' => ''
+                                   )
      )
 );

plugins/tags/_define.php

@@ -20 +20 @@
           'permissions' =>    'usage,contentadmin',
           'priority' =>       1001,     // Must be higher than dcLegacyEditor/dcCKEditor priority (ie 1000)
-          'type'         =>        'plugin'
+          'type'         =>        'plugin',
+          'settings'     =>        array(
+                                        'pref' => '#user-options.tags_prefs'
+                                   )
      )
 );

plugins/tags/inc/tags.behaviors.php

@@ -363 +363 @@
 
           echo
+          '<div class="fieldset"><h5 id="tags_prefs">'.__('Tags').'</h5>'.
           '<p><label for="user_tag_list_format" class="classic">'.__('Tags list format:').'</label> '.
           form::combo('user_tag_list_format',$combo,$value).
-          '</p>';
+          '</p></div>';
      }
 

plugins/themeEditor/_admin.php

@@ -60 +60 @@
           echo
                '<div class="fieldset two-cols clearfix">'.
-               '<h5>'.__('Syntax highlighting').'</h5>';
+               '<h5 id="themeEditor_prefs">'.__('Syntax highlighting').'</h5>';
           echo
                '<div class="col">'.

plugins/themeEditor/_define.php

@@ -18 +18 @@
      /* Version */            '1.3',
      array(
-          'type'         =>        'plugin'
+          'type'         =>        'plugin',
+          'settings'     =>        array(
+                                        'pref' => '#user-options.themeEditor_prefs'
+                                   )
      )
 );