From 99ed3cc12ecc58a1e7f62ab77240d1886775a98f Mon Sep 17 00:00:00 2001
From: Byrne <byrne@majordojo.com>
Date: Fri, 22 Oct 2010 22:21:51 -0700
Subject: [PATCH] [#371 state:resolved] Updated to the latest version of Config
 Assistant to squash deprecation warnings.

---
 addons/ConfigAssistant.plugin/config.yaml     |   6 +-
 .../lib/ConfigAssistant/Init.pm               |  62 +++++++---
 .../lib/ConfigAssistant/Plugin.pm             | 113 +++++++++++++++---
 .../lib/ConfigAssistant/Prefs.pm              |  18 +--
 .../lib/ConfigAssistant/Static.pm             |  25 ++--
 .../lib/ConfigAssistant/Util.pm               |   2 +-
 6 files changed, 174 insertions(+), 52 deletions(-)

diff --git a/addons/ConfigAssistant.plugin/config.yaml b/addons/ConfigAssistant.plugin/config.yaml
index fb0dd47d6..22a8410af 100644
--- a/addons/ConfigAssistant.plugin/config.yaml
+++ b/addons/ConfigAssistant.plugin/config.yaml
@@ -4,7 +4,7 @@ key: ConfigAssistant
 author_link: http://www.majordojo.com/
 author_name: Byrne Reese
 description: This plugin provides a simple YAML based framework for creating plugin and theme configuration options.
-version: 2.0.1
+version: 2.1.3
 static_version: 4
 schema_version: 2
 
@@ -63,8 +63,12 @@ config_types:
     handler: $ConfigAssistant::ConfigAssistant::Plugin::type_link_group
   category:
     handler: $ConfigAssistant::ConfigAssistant::Plugin::type_category
+  category_list:
+    handler: $ConfigAssistant::ConfigAssistant::Plugin::type_category_list
   folder:
     handler: $ConfigAssistant::ConfigAssistant::Plugin::type_folder
+  folder_list:
+    handler: $ConfigAssistant::ConfigAssistant::Plugin::type_folder_list
 
 upgrade_functions:
   static_copy:
diff --git a/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Init.pm b/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Init.pm
index 62d9f5be5..13d708583 100644
--- a/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Init.pm
+++ b/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Init.pm
@@ -36,7 +36,8 @@ sub init_app {
         # runs it sees it and will run the upgrade_function.
         # If this isn't the upgrade screen, just quit.
         my $cfg = MT->config('PluginSchemaVersion');
-        if ( $cfg->{$plugin->id} eq '' ) {
+        # $cfg->{$plugin->id} = '0.1';  ### UNCOMMENT TO TEST UPGRADE ###
+        if ( ($cfg->{$plugin->id}||'') eq '' ) {
             # There is no schema version set. Set one!
             $cfg->{$plugin->id} = '0.1';
         }
@@ -197,33 +198,32 @@ sub load_tags {
         # First initialize all the tags associated with themes
         my @sets = keys %{ $r->{'template_sets'} };
         foreach my $set (@sets) {
-            if ( $r->{'template_sets'}->{$set}->{'options'} ) {
+            if ( $obj->registry('template_sets', $set, 'options') ) {
                 foreach my $opt (
-                    keys %{ $r->{'template_sets'}->{$set}->{'options'} } )
+                    keys %{ $obj->registry('template_sets', $set, 'options') } )
                 {
-                    my $option =
-                      $r->{'template_sets'}->{$set}->{'options'}->{$opt};
+                    my $option = $obj->registry('template_sets', $set, 'options', $opt);
 
                     # If the option does not define a tag name,
                     # then there is no need to register one
                     next if ( !defined( $option->{tag} ) );
                     my $tag = $option->{tag};
 
-               # TODO - there is the remote possibility that a template set
-               # will attempt to register a duplicate tag. This case needs to be
-               # handled properly. Or does it?
-               # Note: the tag handler takes into consideration the blog_id, the
-               # template set id and the option/setting name.
+                    # TODO - there is the remote possibility that a template set
+                    # will attempt to register a duplicate tag. This case needs to be
+                    # handled properly. Or does it?
+                    # Note: the tag handler takes into consideration the blog_id, the
+                    # template set id and the option/setting name.
                     if ( $tag =~ s/\?$// ) {
                         $tags->{block}->{$tag} = sub {
                             my $blog = $_[0]->stash('blog');
                             my $bset = $blog->template_set;
                             $_[0]->stash( 'field', $bset . '_' . $opt );
                             $_[0]->stash( 'plugin_ns',
-                                find_theme_plugin($bset)->id );
+                                          find_theme_plugin($bset)->id );
                             $_[0]->stash( 'scope', 'blog' );
                             runner( '_hdlr_field_cond',
-                                'ConfigAssistant::Plugin', @_ );
+                                    'ConfigAssistant::Plugin', @_ );
                         };
                     }
                     elsif ( $tag ne '' ) {
@@ -279,9 +279,25 @@ sub load_tags {
                                 $_[0]->stash( 'plugin_ns',
                                               find_theme_plugin($bset)->id );
                                 $_[0]->stash( 'scope', 'blog' );
+                                $_[0]->stash( 'show_children', (defined $option->{show_children} ? $option->{show_children} : 1 ) );
                                 runner( '_hdlr_field_link_group',
                                         'ConfigAssistant::Plugin', @_ );
                             };
+                        } elsif ($option->{'type'} eq 'category_list' or $option->{'type'} eq 'folder_list') {
+                            my $t = $option->{'type'};
+                            my $tag_type = $t eq 'category_list' ? 'Categories' : 'Folders';
+                            my $obj_class = substr($t, 0, index($t, '_list'));
+                            $tags->{block}->{$tag . $tag_type} = sub {
+                                $_[0]->stash('obj_class', $obj_class);
+                                my $blog = $_[0]->stash('blog');
+                                my $bset = $blog->template_set;
+                                $_[0]->stash( 'field', $bset . '_' . $opt );
+                                $_[0]->stash( 'plugin_ns',
+                                              find_theme_plugin($bset)->id );
+                                $_[0]->stash( 'scope', 'blog' );
+                                runner( '_hdlr_field_category_list',
+                                    'ConfigAssistant::Plugin', @_ );
+                            };
                         }
                     }
                 }
@@ -340,7 +356,6 @@ sub load_tags {
                                 'ConfigAssistant::Plugin', @_ );
                     };
                     
-                    
                 } elsif ($option->{'type'} eq 'file') {
                     $tags->{block}->{$tag . 'Asset'} = sub {
                         my $blog = $_[0]->stash('blog');
@@ -352,6 +367,7 @@ sub load_tags {
                         runner( '_hdlr_field_asset',
                                 'ConfigAssistant::Plugin', @_ );
                     };
+
                 } elsif ($option->{'type'} eq 'link-group') {
                     $tags->{block}->{$tag . 'Links'} = sub {
                         my $blog = $_[0]->stash('blog');
@@ -363,12 +379,28 @@ sub load_tags {
                         runner( '_hdlr_field_link_group',
                                 'ConfigAssistant::Plugin', @_ );
                     };
+
+                } elsif ($option->{'type'} eq 'category_list' or $option->{'type'} eq 'folder_list') {
+                    my $t = $option->{'type'};
+                    my $tag_type = $t eq 'category_list' ? 'Categories' : 'Folders';
+                    my $obj_class = substr($t, 0, index($t, '_list'));
+                    $tags->{block}->{$tag . $tag_type} = sub {
+                        $_[0]->stash('obj_class', $obj_class);
+                        my $blog = $_[0]->stash('blog');
+                        my $bset = $blog->template_set;
+                        $_[0]->stash( 'field', $bset . '_' . $opt );
+                        $_[0]->stash( 'plugin_ns',
+                                      find_theme_plugin($bset)->id );
+                        $_[0]->stash( 'scope', 'blog' );
+                        runner( '_hdlr_field_category_list',
+                                'ConfigAssistant::Plugin', @_ );
+                    };
                 }
             }
         }
         
         # Create plugin-specific tags to the static content
-        if ( $r->{'static_version'} ) {
+        if ( $r && $r->{'static_version'} ) {
             # Create the plugin-specific static file path tag, such as "ConfigAssistantStaticFilePath."
             my $tag;
             $tag = $obj->id . 'StaticFilePath';
@@ -382,7 +414,7 @@ sub load_tags {
             };
             # Create the plugin-specific static web path tag, such as "ConfigAssistantStaticWebPath."
             $tag = $obj->id . 'StaticWebPath';
-            my $url = $app->config('StaticWebPath');
+            my $url = $app->static_path;
             $url   .= '/' unless $url =~ m!/$!;
             $url   .= 'support/plugins/'.$obj->id.'/';
             $tags->{function}->{$tag} = sub {
diff --git a/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Plugin.pm b/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Plugin.pm
index b7470bb32..c0b0c7034 100644
--- a/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Plugin.pm
+++ b/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Plugin.pm
@@ -22,7 +22,7 @@ sub tag_plugin_static_web_path {
                           $ctx->stash('tag'), $sig)
         );
     } elsif ( $obj->registry('static_version') ) {
-        my $url = MT->config('StaticWebPath');
+        my $url = MT->instance->static_path;
         $url   .= '/' unless $url =~ m!/$!;
         $url   .= 'support/plugins/'.$obj->id.'/';
         return $url;
@@ -45,8 +45,8 @@ sub tag_plugin_static_file_path {
                           $ctx->stash('tag'), $sig)
         );
     } elsif ( $obj->registry('static_version') ) {
-        my $url = File::Spec->catdir( MT->config('StaticFilePath'), 'support', 'plugins', $obj->id );
-        return $url;
+        return File::Spec->catdir( 
+            MT->instance->static_file_path, 'support', 'plugins', $obj->id );
     } else {
         return $ctx->error(
             MT->translate(
@@ -60,7 +60,7 @@ sub tag_plugin_static_file_path {
 sub theme_options {
     my $app     = shift;
     my ($param) = @_;
-    my $q       = $app->{query};
+    my $q       = $app->can('query') ? $app->query : $app->param;
     my $blog    = $app->blog;
 
     $param ||= {};
@@ -115,6 +115,15 @@ sub theme_options {
             }
             next unless $cond->();
         }
+        if (!$field->{'type'}) {
+            MT->log(
+                {
+                    message => "Option '$optname' in template set '$ts' did not declare a type. Skipping"
+                }
+            );
+            next;
+        }
+
 
         my $field_id = $ts . '_' . $optname;
 
@@ -258,7 +267,7 @@ sub theme_options {
 # Code for this method taken from MT::CMS::Plugin
 sub save_config {
     my $app = shift;
-    my $q          = $app->param;
+    my $q          = $app->can('query') ? $app->query : $app->param;
     my $plugin_sig = $q->param('plugin_sig');
     my $profile    = $MT::Plugins{$plugin_sig};
     my $blog_id    = $q->param('blog_id');
@@ -443,7 +452,7 @@ sub type_colorpicker {
 sub type_link_group {
     my $app = shift;
     my ( $ctx, $field_id, $field, $value ) = @_;
-    my $static = $app->config->StaticWebPath;
+    my $static = $app->static_path;
     $value = '"[]"' if (!$value || $value eq '');
     eval "\$value = $value";
     if ($@) { $value = '"[]"'; }
@@ -673,7 +682,7 @@ sub type_radio_image {
     my $app = shift;
     my ( $ctx, $field_id, $field, $value ) = @_;
     my $out;
-    my $static = $app->config->StaticWebPath;
+    my $static = $app->static_path;
     $out .= "      <ul class=\"pkg\">\n";
     while ( $field->{values} =~ /\"([^\"]*)\":\"([^\"]*)\",?/g ) {
         my ($url,$label) = ($1,$2);
@@ -812,6 +821,46 @@ sub type_category {
     return $out;
 }
 
+sub type_folder_list {
+    my $app = shift;
+    my ( $ctx, $field_id, $field, $value ) = @_;
+    $ctx->stash('object_class', 'folder');
+    return type_category_list($app, @_);
+}
+
+sub type_category_list {
+    my $app = shift;
+    my ( $ctx, $field_id, $field, $value ) = @_;
+    $value = defined($value) ? $value: 0;
+    my @values = ref $value eq 'ARRAY' ? @$value : (0);
+    my $out;
+    my $obj_class = $ctx->stash('object_class') || 'category';
+
+    my $params = { };
+    $params->{blog_id} = $app->blog->id;
+    $params->{parent} = 0 unless $ctx->stash('show_children');
+
+    my @cats = MT->model($obj_class)->load( $params,
+                                            { sort => 'label' });
+    $out .= "      <select style=\"width: 300px;height:100px\" name=\"$field_id\" multiple=\"true\">\n";
+    foreach my $cat (@cats) {
+        my $found = 0;
+        foreach (@values) {
+            if ($cat->id == $_) {
+                $found = 1;
+            }
+        }
+        $out .=
+            "        <option value=\""
+          . $cat->id . "\" "
+          . ( $found ? " selected" : "" ) . ">"
+          . $cat->label
+          . "</option>\n";
+    }
+    $out .= "      </select>\n";
+    return $out;
+}
+
 sub type_folder {
     my $app = shift;
     my ( $ctx, $field_id, $field, $value ) = @_;
@@ -889,6 +938,34 @@ sub _hdlr_field_array_contains {
     return MT::Template::Context::_hdlr_pass_tokens_else(@_);
 }
 
+sub _hdlr_field_category_list {
+    my $plugin = shift;
+    my ( $ctx, $args, $cond ) = @_;
+    my $field     = $ctx->stash('field')
+      or return _no_field($ctx);
+    my $value = _get_field_value($ctx);
+    my @ids = split(/,/, $value);
+    my $class = $ctx->stash('obj_class');
+
+    my @categories = MT->model( $class )->load({ id => \@ids });
+    my $out = '';
+    my $vars = $ctx->{__stash}{vars};
+    my $glue = $args->{glue};
+    for (my $index = 0; $index <= $#categories; $index++) {
+        
+        local $vars->{__first__} = $index == 0;
+        local $vars->{__last__}  = $index == $#categories;
+        local $vars->{__odd__}   = $index % 2 == 1;
+        local $vars->{__even__}  = $index % 2 == 0;
+        local $vars->{__index__} = $index;
+        local $vars->{__size__}  = scalar(@categories);
+
+        $ctx->stash('category', $categories[$index]);
+        $out .= $ctx->slurp( $args, $cond ) . ($glue && $index< $#categories ? $glue : ''  );
+    }
+    return $out;
+}
+
 sub _get_field_value {
     my ($ctx) = @_;
     my $plugin_ns = $ctx->stash('plugin_ns');
@@ -907,6 +984,9 @@ sub _get_field_value {
     else {
         $value = $plugin->get_config_value($field);
     }
+    if (ref $value eq 'ARRAY') {
+        $value = join (',', @$value);
+    }
     return $value;
 }
 
@@ -1157,9 +1237,10 @@ sub plugin_options {
 sub entry_search_api_prep {
     my $app = MT->instance;
     my ($terms, $args, $blog_id) = @_;
+    my $q = $app->can('query') ? $app->query : $app->param;
 
     $terms->{blog_id} = $blog_id if $blog_id;
-    $terms->{status} = $app->param('status') if ($app->param('status'));
+    $terms->{status} = $q->param('status') if ($q->param('status'));
 
     my $search_api = $app->registry("search_apis");
     my $api = $search_api->{entry};
@@ -1176,9 +1257,10 @@ sub entry_search_api_prep {
 
 sub list_entry_mini {
     my $app = shift;
+    my $q = $app->can('query') ? $app->query : $app->param;
 
-    my $blog_id  = $app->param('blog_id') || 0;
-    my $obj_type = $app->param('class') || 'entry';
+    my $blog_id  = $q->param('blog_id') || 0;
+    my $obj_type = $q->param('class') || 'entry';
     my $pkg      = $app->model($obj_type) or return "Invalid request: unknown class $obj_type";
 
     my $terms;
@@ -1200,8 +1282,8 @@ sub list_entry_mini {
             params   => {
                 panel_searchable => 1,
                 edit_blog_id     => $blog_id,
-                edit_field       => $app->param('edit_field'),
-                search           => $app->param('search'),
+                edit_field       => $q->param('edit_field'),
+                search           => $q->param('search'),
                 blog_id          => $blog_id,
             },
             code => sub {
@@ -1234,13 +1316,14 @@ sub list_entry_mini {
 
 sub select_entry {
     my $app = shift;
+    my $q = $app->can('query') ? $app->query : $app->param;
 
-    my $class = $app->param('class') || 'entry';
-    my $obj_id = $app->param('id')
+    my $class = $q->param('class') || 'entry';
+    my $obj_id = $q->param('id')
       or return $app->errtrans('No id');
     my $obj = MT->model($class)->load($obj_id)
       or return $app->errtrans( 'No entry #[_1]', $obj_id );
-    my $edit_field = $app->param('edit_field')
+    my $edit_field = $q->param('edit_field')
       or return $app->errtrans('No edit_field');
 
     my $plugin = MT->component('ConfigAssistant') or die "OMG NO COMPONENT!?!";
diff --git a/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Prefs.pm b/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Prefs.pm
index e5423390f..92a2d17d3 100644
--- a/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Prefs.pm
+++ b/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Prefs.pm
@@ -5,10 +5,9 @@ use strict;
 sub apply {
     my $app = shift;
     my ($param) = @_;
-
     $app->validate_magic or return;
 
-    my $q    = $app->{query};
+    my $q = $app->can('query') ? $app->query : $app->param;
     my $blog = MT->model('blog')->load( $q->param('blog_id') );
     my $pid  = $q->param('pref_id');
 
@@ -19,9 +18,9 @@ sub apply {
             'mode' => 'ca_prefs_chooser',
             'args' => {
                 'prefs_applied' => 1,
-                'blog_id'       => $app->param('blog_id'),
+                'blog_id'       => $q->param('blog_id'),
                 'return_args'   => $app->return_args,
-                'magic_token'   => $app->param('magic_token')
+                'magic_token'   => $q->param('magic_token')
             }
         )
     );
@@ -30,13 +29,14 @@ sub apply {
 sub chooser {
     my $app     = shift;
     my ($param) = @_;
-    my $q       = $app->{query};
+    my $q = $app->can('query') ? $app->query : $app->param;
     my $blog    = MT->model('blog')->load( $q->param('blog_id') );
 
     $param ||= {};
 
     my $prefs = MT->registry('blog_preferences');
     my @data;
+    my $selected = $blog->selected_config ? $blog->selected_config : '';
     foreach my $pid ( keys %$prefs ) {
         my $pref = $prefs->{$pid};
         push @data,
@@ -45,15 +45,15 @@ sub chooser {
             name        => &{ $pref->{'label'} },
             description => $pref->{'description'},
             order       => $pref->{'order'} || 10,
-            selected    => $blog->selected_config eq $pid
+            selected    => $selected eq $pid
           };
     }
     @data = sort { $a->{order} <=> $b->{order} } @data;
     $param->{prefs}         = \@data;
-    $param->{blog_id}       = $app->param('blog_id');
+    $param->{blog_id}       = $q->param('blog_id');
     $param->{return_args}   = $app->return_args;
-    $param->{magic_token}   = $app->param('magic_token');
-    $param->{prefs_applied} = $app->param('prefs_applied') ? 1 : 0;
+    $param->{magic_token}   = $q->param('magic_token');
+    $param->{prefs_applied} = $q->param('prefs_applied') ? 1 : 0;
 
     return $app->load_tmpl( 'prefs_chooser.mtml', $param )
 }
diff --git a/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Static.pm b/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Static.pm
index 5eeadc9ac..cf704a8af 100644
--- a/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Static.pm
+++ b/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Static.pm
@@ -11,7 +11,7 @@ sub upgrade {
     my $app  = MT->instance;
     
     # Static File Path must be set in order to copy files.
-    if ( $app->config('StaticFilePath') ) {
+    if ( $app->static_file_path ) {
         use MT::ConfigMgr;
         my $cfg = MT::ConfigMgr->instance;
 
@@ -27,6 +27,8 @@ sub upgrade {
             my $static_version = $registry->{'static_version'} || '0';
             # The saved version
             my $ver = MT->config('PluginStaticVersion');
+            # $ver = undef;  ### UNCOMMENT TO TEST STATIC UPGRADE ###
+
             # Check to see if $plugin->id is valid. If it's not, we need to undef 
             # $ver so that we don't try to grab the static_version variable.
             # $plugin->id seems to throw an error for some Six Apart-originated
@@ -54,8 +56,7 @@ sub upgrade {
 
                 # Process all of the files found in the static folder.
                 my @messages = _traverse_hash($dir_hash, $plugin, '', $self, @$skip);
-                my $message = join('<br />', @messages);
-                $self->progress($message);
+                $self->progress($_) foreach @messages;
 
                 # Update mt_config with the new static_version.
                 my $plugin_id = $plugin->id;
@@ -119,9 +120,11 @@ sub _traverse_hash {
                 }
             }
             if ($process_file) {
-                my $src = File::Spec->catfile($plugin->path, 'static', $dir, $cur_item);
-                my $dest = File::Spec->catfile($app->config('StaticFilePath'), 
-                            'support', 'plugins', $plugin->id, $dir, $cur_item);
+                my $src = File::Spec->catfile(
+                    $plugin->path, 'static', $dir, $cur_item );
+                my $dest = File::Spec->catfile(
+                    $app->static_file_path, 'support', 'plugins', 
+                    $plugin->id,             $dir,      $cur_item   );
                 $message = _write_file($src, $dest, $self);
                 push @messages, $message;
             }
@@ -139,13 +142,13 @@ sub _make_dir {
         or return MT::FileMgr->errstr;
 
     my $app = MT->instance;
-    my $dir = File::Spec->catfile($app->config('StaticFilePath'), 'support', 'plugins', $dir);
+    my $dir = File::Spec->catfile($app->static_file_path, 'support', 'plugins', $dir);
     if ( $fmgr->mkpath($dir) ) {
         # Success!
         my $app = MT->instance;
-        my $static_file_path = $app->config('StaticFilePath');
+        my $static_file_path = $app->static_file_path;
         $dir =~ s!$static_file_path/support/plugins/(.*)!$1!;
-        return "Created folder $dir.";
+        return "<nobr>Created folder: $dir</nobr>";
     }
     else {
         $self->error($fmgr->errstr);
@@ -169,9 +172,9 @@ sub _write_file {
         # Only provide a "copied" message if the file was successfully written.
         if ($bytes) {
             my $app = MT->instance;
-            my $static_file_path = $app->config('StaticFilePath');
+            my $static_file_path = $app->static_file_path;
             $dest =~ s!$static_file_path/support/plugins/(.*)!$1!;
-            return "Copied $dest.";
+            return "<nobr>Copied $dest</nobr>";
         }
     }
     return;
diff --git a/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Util.pm b/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Util.pm
index 5cf49bbc9..61a2bf3e4 100644
--- a/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Util.pm
+++ b/addons/ConfigAssistant.plugin/lib/ConfigAssistant/Util.pm
@@ -27,7 +27,7 @@ sub process_file_upload {
                     message => $app->translate("Failed to validate magic.")
                 };
 
-    my $q = $app->param;
+    my $q = $app->can('query') ? $app->query : $app->param;
     my ($fh, $info) = $app->upload_info( $param_name );
 
     return { status => NO_UPLOAD() } unless $fh;