rt/etc/upgrade/switch-templates-to.in

   1 #!@PERL@
   2 # BEGIN BPS TAGGED BLOCK {{{
   3 #
   4 # COPYRIGHT:
   5 #
   6 # This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
   7 #                                          <sales@bestpractical.com>
   8 #
   9 # (Except where explicitly superseded by other copyright notices)
  10 #
  11 #
  12 # LICENSE:
  13 #
  14 # This work is made available to you under the terms of Version 2 of
  15 # the GNU General Public License. A copy of that license should have
  16 # been provided with this software, but in any event can be snarfed
  17 # from www.gnu.org.
  18 #
  19 # This work is distributed in the hope that it will be useful, but
  20 # WITHOUT ANY WARRANTY; without even the implied warranty of
  21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22 # General Public License for more details.
  23 #
  24 # You should have received a copy of the GNU General Public License
  25 # along with this program; if not, write to the Free Software
  26 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  27 # 02110-1301 or visit their web page on the internet at
  28 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  29 #
  30 #
  31 # CONTRIBUTION SUBMISSION POLICY:
  32 #
  33 # (The following paragraph is not intended to limit the rights granted
  34 # to you to modify and distribute this software under the terms of
  35 # the GNU General Public License and is only of importance to you if
  36 # you choose to contribute your changes and enhancements to the
  37 # community by submitting them to Best Practical Solutions, LLC.)
  38 #
  39 # By intentionally submitting any modifications, corrections or
  40 # derivatives to this work, or any other work intended for use with
  41 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  42 # you are the copyright holder for those contributions and you grant
  43 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  44 # royalty-free, perpetual, license to use, copy, create derivative
  45 # works based on those contributions, and sublicense and distribute
  46 # those contributions and any derivatives thereof.
  47 #
  48 # END BPS TAGGED BLOCK }}}
  49 use 5.10.1;
  50 use strict;
  51 use warnings;
  52
  53 use lib "@LOCAL_LIB_PATH@";
  54 use lib "@RT_LIB_PATH@";
  55
  56 use RT::Interface::CLI qw(Init);
  57 Init();
  58
  59 my $to = shift || '';
  60 my $from;
  61
  62 if ($to =~ /html|text/i) {
  63     $to   = $to =~ /html/i  ? 'html' : 'text';
  64     $from = $to eq 'html'   ? 'text' : 'html';
  65 } else {
  66     print "Usage: $0 [html|text]\n";
  67     warn "Please specify if you'd like to switch to HTML or text templates.\n";
  68     exit 1;
  69 }
  70
  71
  72 my @templates = (
  73     "Autoreply",
  74     "Transaction",
  75     "Admin Correspondence",
  76     "Correspondence",
  77     "Admin Comment",
  78     "Status Change",
  79     "Resolved",
  80     "New Pending Approval",
  81     "Approval Passed",
  82     "All Approvals Passed",
  83     "Approval Rejected",
  84     "Approval Ready for Owner",
  85 );
  86
  87 $RT::Handle->BeginTransaction();
  88
  89 use RT::Scrips;
  90 my $scrips = RT::Scrips->new( RT->SystemUser );
  91 $scrips->UnLimit;
  92
  93 for (@templates) {
  94     $scrips->Limit(
  95         FIELD => 'Template',
  96         VALUE => ($to eq 'html' ? $_ : "$_ in HTML"),
  97         ENTRYAGGREGATOR => 'OR'
  98     );
  99 }
 100
 101 my $switched = 0;
 102 while ( my $s = $scrips->Next ) {
 103     my $new = $s->TemplateObj->Name;
 104
 105     if ($to eq 'html') {
 106         $new .= ' in HTML';
 107     } else {
 108         $new =~ s/ in HTML$//;
 109     }
 110
 111     print $s->id, ": ", $s->Description, "\n";
 112     print "    ", $s->TemplateObj->Name, " -> $new\n\n";
 113
 114     my ($ok, $msg) = $s->SetTemplate($new);
 115
 116     if ($ok) {
 117         $switched++;
 118     } else {
 119         warn "    Couldn't switch templates: $msg\n";
 120     }
 121 }
 122
 123 $RT::Handle->Commit;
 124
 125 if ($switched) {
 126     print <<"    EOT";
 127 Switched $switched scrips to $to templates.  You should now manually port any
 128 customizations from the old templates to the new templates.
 129     EOT
 130     exit 1 if $switched != $scrips->Count;
 131 }
 132 elsif ($scrips->Count) {
 133     print <<"    EOT";
 134 @{[$scrips->Count]} scrips using $from templates were found, but none were
 135 successfully switched to $to.  See the errors above.
 136     EOT
 137     exit 1;
 138 }
 139 else {
 140     print <<"    EOT";
 141 No scrips were found using the $from templates, so none were switched to
 142 $to templates.
 143     EOT
 144 }
 145