aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/extension-convert.pl
blob: 88718cf832f62b45a856787cc771fc0bc67d0518 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
#!/usr/bin/perl -w
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by the Initial Developer are Copyright (C) 2009 the
# Initial Developer. All Rights Reserved.
#
# Contributor(s):
#   Max Kanat-Alexander <mkanat@bugzilla.org>

use strict;
use warnings;
use lib qw(. lib);

use Bugzilla;
use Bugzilla::Constants;
use Bugzilla::Util qw(trim);

use File::Basename;
use File::Copy qw(move);
use File::Find;
use File::Path qw(mkpath rmtree);

my $from = $ARGV[0]
  or die <<END;
You must specify the name of the extension you are converting from,
as the first argument.
END
my $extension_name = ucfirst($from);

my $extdir = bz_locations()->{'extensionsdir'};

my $from_dir = "$extdir/$from";
if (!-d $from_dir) {
    die "$from_dir does not exist.\n";
}

my $to_dir = "$extdir/$extension_name";
if (-d $to_dir) {
    die "$to_dir already exists, not converting.\n";
}

if (ON_WINDOWS) {
    # There's no easy way to recursively copy a directory on Windows.
    print "WARNING: This will modify the contents of $from_dir.\n",
          "Press Ctrl-C to stop or any other key to continue...\n";
    getc;
    move($from_dir, $to_dir) 
        || die "rename of $from_dir to $to_dir failed: $!";
}
else {
    print "Copying $from_dir to $to_dir...\n";
    system("cp", "-r", $from_dir, $to_dir);
}

# Make sure we don't accidentally modify the $from_dir anywhere else 
# in this script.
undef $from_dir;

if (!-d $to_dir) {
    die "$to_dir was not created.\n";
}

my $version = get_version($to_dir);
move_template_hooks($to_dir);
rename_module_packages($to_dir, $extension_name);
my $install_requirements = get_install_requirements($to_dir);
my ($modules, $subs) = code_files_to_subroutines($to_dir);

my $config_pm = <<END;
package Bugzilla::Extension::$extension_name;
use strict;
use constant NAME => '$extension_name';
$install_requirements
__PACKAGE__->NAME;
END

my $extension_pm = <<END;
package Bugzilla::Extension::$extension_name;
use strict;
use base qw(Bugzilla::Extension);

$modules

our \$VERSION = '$version';

$subs

__PACKAGE__->NAME;
END

open(my $config_fh, '>', "$to_dir/Config.pm") || die "$to_dir/Config.pm: $!";
print $config_fh $config_pm;
close($config_fh);
open(my $extension_fh, '>', "$to_dir/Extension.pm") 
  || die "$to_dir/Extension.pm: $!";
print $extension_fh $extension_pm;
close($extension_fh);

rmtree("$to_dir/code");
unlink("$to_dir/info.pl");

###############
# Subroutines #
###############

sub rename_module_packages {
    my ($dir, $name) = @_;
    my $lib_dir = "$dir/lib";

    # We don't want things like Bugzilla::Extension::Testopia::Testopia.
    if (-d "$lib_dir/$name") {
        print "Moving contents of $lib_dir/$name into $lib_dir...\n";
        foreach my $file (glob("$lib_dir/$name/*")) {
            my $dirname = dirname($file);
            my $basename = basename($file);
            rename($file, "$dirname/../$basename") || warn "$file: $!\n";
        }
    }

    my @modules;
    find({ wanted   => sub { $_ =~ /\.pm$/i and push(@modules, $_) }, 
           no_chdir => 1 }, $lib_dir);
    my %module_rename;
    foreach my $file (@modules) {
        open(my $fh, '<', $file) || die "$file: $!";
        my $content = do { local $/ = undef; <$fh> };
        close($fh);
        if ($content =~ /^package (\S+);/m) {
            my $package = $1;
            my $new_name = $file;
            $new_name =~ s/^$lib_dir\///;
            $new_name =~ s/\.pm$//;
            $new_name = join('::', File::Spec->splitdir($new_name));
            $new_name = "Bugzilla::Extension::${name}::$new_name";
            print "Renaming $package to $new_name...\n";
            $content =~ s/^package \Q$package\E;/package \Q$new_name\E;/;
            open(my $write_fh, '>', $file) || die "$file: $!";
            print $write_fh $content;
            close($write_fh);
            $module_rename{$package} = $new_name;
        }
    }

    print "Renaming module names inside of library and code files...\n";
    my @code_files = glob("$dir/code/*.pl");
    rename_modules_internally(\%module_rename, [@modules, @code_files]);
}

sub rename_modules_internally {
    my ($rename, $files) = @_;

    # We can't use \b because :: matches \b.
    my $break = qr/^|[^\w:]|$/;
    foreach my $file (@$files) {
        open(my $fh, '<', $file) || die "$file: $!";
        my $content = do { local $/ = undef; <$fh> };
        close($fh);
        foreach my $old_name (keys %$rename) {
            my $new_name = $rename->{$old_name};
            $content =~ s/($break)\Q$old_name\E($break)/$1$new_name$2/gms;
        }
        open(my $write_fh, '>', $file) || die "$file: $!";
        print $write_fh $content;
        close($write_fh);
    }
}

sub get_version {
    my ($dir) = @_;
    print "Getting version info from info.pl...\n";
    my $info;
    {
        local @INC = ("$dir/lib", @INC);
        $info = do "$dir/info.pl"; die $@ if $@;
    }
    return $info->{version};
}

sub get_install_requirements {
    my ($dir) = @_;
    my $file = "$dir/code/install-requirements.pl";
    return '' if !-f $file;

    print "Moving install-requirements.pl code into Config.pm...\n";
    my ($modules, $code) = process_code_file($file);
    $modules = join('', @$modules);
    $code = join('', @$code);
    if ($modules) {
        return "$modules\n\n$code";
    }
    return $code;
}

sub process_code_file {
    my ($file) = @_;
    open(my $fh, '<', $file) || die "$file: $!";
    my $stuff_started;
    my (@modules, @code);
    foreach my $line (<$fh>) {
        $stuff_started = 1 if $line !~ /^#/;
        next if !$stuff_started;
        next if $line =~ /^use (warnings|strict|lib|Bugzilla)[^\w:]/;
        if ($line =~ /^(?:use|require)\b/) {
            push(@modules, $line);
        }
        else {
            push(@code, $line);
        }
    }
    close $fh;
    return (\@modules, \@code);
}

sub code_files_to_subroutines {
    my ($dir) = @_;

    my @dir_files = glob("$dir/code/*.pl");
    my (@all_modules, @subroutines);
    foreach my $file (@dir_files) {
        next if $file =~ /install-requirements/;
        print "Moving $file code into Extension.pm...\n";
        my ($modules, $code) = process_code_file($file);
        my @code_lines = map { "    $_" } @$code;
        my $code_string = join('', @code_lines);
        $code_string =~ s/Bugzilla->hook_args/\$args/g;
        $code_string =~ s/my\s+\$args\s+=\s+\$args;//gs;
        chomp($code_string);
        push(@all_modules, @$modules);
        my $name = basename($file);
        $name =~ s/-/_/;
        $name =~ s/\.pl$//;

        my $subroutine = <<END;
sub $name {
    my (\$self, \$args) = \@_;
$code_string
}
END
        push(@subroutines, $subroutine);
    }

    my %seen_modules = map { trim($_) => 1 } @all_modules;
    my $module_string = join("\n", sort keys %seen_modules);
    my $subroutine_string = join("\n", @subroutines);
    return ($module_string, $subroutine_string);
}

sub move_template_hooks {
    my ($dir) = @_;
    foreach my $lang (glob("$dir/template/*")) {
        next if !_file_matters($lang);
        my $hook_container = "$lang/default/hook";
        mkpath($hook_container) || warn "$hook_container: $!";
        # Hooks can be in all sorts of weird places, including
        # template/default/hook.
        foreach my $file (glob("$lang/*")) {
            next if !_file_matters($file, 1);
            my $dirname = basename($file);
            print "Moving $file to $hook_container/$dirname...\n";
            rename($file, "$hook_container/$dirname") || die "move failed: $!";
        }
    }
}

sub _file_matters {
     my ($path, $tmpl) = @_;
     my @ignore = qw(default custom CVS);
     my $file = basename($path);
     return 0 if grep(lc($_) eq lc($file), @ignore);
      # Hidden files
     return 0 if $file =~ /^\./;
     if ($tmpl) {
         return 1 if $file =~ /\.tmpl$/;
     }
     return 0 if !-d $path;
     return 1;
}

__END__

=head1 NAME

extension-convert.pl - Convert extensions from the pre-3.6 format to the 
3.6 format.

=head1 SYNOPSIS

 contrib/extension-convert.pl name

 Converts an extension in the F<extensions/> directory into the new
 extension layout for Bugzilla 3.6.