From c62ddd06ff62e627ffd411b8ccb0fa881e1591d0 Mon Sep 17 00:00:00 2001 From: "mkanat%bugzilla.org" <> Date: Wed, 25 Nov 2009 05:02:55 +0000 Subject: Bug 530252: Create a script that sets up the framework of an extension Patch by Max Kanat-Alexander (module owner) a=mkanat --- template/en/default/extensions/config.pm.tmpl | 41 +++++++++++++++++++ template/en/default/extensions/extension.pm.tmpl | 46 +++++++++++++++++++++ .../en/default/extensions/hook-readme.txt.tmpl | 27 +++++++++++++ template/en/default/extensions/license.txt.tmpl | 47 ++++++++++++++++++++++ .../en/default/extensions/name-readme.txt.tmpl | 38 +++++++++++++++++ template/en/default/extensions/util.pm.tmpl | 42 +++++++++++++++++++ template/en/default/global/messages.html.tmpl | 7 +++- template/en/default/global/user-error.html.tmpl | 16 ++++++-- 8 files changed, 259 insertions(+), 5 deletions(-) create mode 100644 template/en/default/extensions/config.pm.tmpl create mode 100644 template/en/default/extensions/extension.pm.tmpl create mode 100644 template/en/default/extensions/hook-readme.txt.tmpl create mode 100644 template/en/default/extensions/license.txt.tmpl create mode 100644 template/en/default/extensions/name-readme.txt.tmpl create mode 100644 template/en/default/extensions/util.pm.tmpl (limited to 'template') diff --git a/template/en/default/extensions/config.pm.tmpl b/template/en/default/extensions/config.pm.tmpl new file mode 100644 index 000000000..6997ec178 --- /dev/null +++ b/template/en/default/extensions/config.pm.tmpl @@ -0,0 +1,41 @@ +[%# -*- mode: perl -*- %] +[%# 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 + #%] + +[%# INTERFACE: + # name: string; The name of the extension. + #%] + +[% PROCESS global/variables.none.tmpl %] + +[% PROCESS extensions/license.txt.tmpl %] + +package B[% %]ugzilla::Extension::[% name %]; +use strict; + +use constant NAME => '[% name %]'; + +use constant REQUIRED_MODULES => [ +]; + +use constant OPTIONAL_MODULES => [ +]; + +__PACKAGE__->NAME; diff --git a/template/en/default/extensions/extension.pm.tmpl b/template/en/default/extensions/extension.pm.tmpl new file mode 100644 index 000000000..249227103 --- /dev/null +++ b/template/en/default/extensions/extension.pm.tmpl @@ -0,0 +1,46 @@ +[%# -*- mode: perl -*- %] +[%# 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 + #%] + +[%# INTERFACE: + # name: string; The name of the extension. + #%] + +[% PROCESS global/variables.none.tmpl %] + +[% PROCESS extensions/license.txt.tmpl %] + +package B[% %]ugzilla::Extension::[% name %]; +use strict; +use base qw(B[% %]ugzilla::Extension); + +# This code for this is in [% path %]/lib/Util.pm +use B[% %]ugzilla::Extension::[% name %]::Util; + +our $VERSION = '0.01'; + +# See the documentation of B[% %]ugzilla::Hook ("perldoc B[% %]ugzilla::Hook" +# in the bugzilla directory) for a list of all available hooks. +sub install_update_db { + my ($self, $args) = @_; + +} + +__PACKAGE__->NAME; diff --git a/template/en/default/extensions/hook-readme.txt.tmpl b/template/en/default/extensions/hook-readme.txt.tmpl new file mode 100644 index 000000000..efceec136 --- /dev/null +++ b/template/en/default/extensions/hook-readme.txt.tmpl @@ -0,0 +1,27 @@ +[%# 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 + #%] + +[% PROCESS global/variables.none.tmpl %] + +Template hooks go in this directory. Template hooks are called in normal +[%+ terms.Bugzilla %] templates like [[% '%' %] Hook.process('some-hook') %]. +More information about them can be found in the documentation of +B[% %]ugzilla::Extension. (Do "perldoc B[% %]ugzilla::Extension" from the main +[%+ terms.Bugzilla %] directory to see that documentation.) diff --git a/template/en/default/extensions/license.txt.tmpl b/template/en/default/extensions/license.txt.tmpl new file mode 100644 index 000000000..964e07505 --- /dev/null +++ b/template/en/default/extensions/license.txt.tmpl @@ -0,0 +1,47 @@ +[%# -*- mode: perl -*- %] +[%# 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 + #%] + +[%# INTERFACE: + # name: string; The name of the extension. + #%] + +[% PROCESS global/variables.none.tmpl %] + +# -*- Mode: perl; indent-tabs-mode: nil -*- +# +# 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 [% name %] [%+ terms.Bugzilla %] Extension. +# +# The Initial Developer of the Original Code is YOUR NAME +# Portions created by the Initial Developer are Copyright (C) [% year %] the +# Initial Developer. All Rights Reserved. +# +# Contributor(s): +# YOUR NAME diff --git a/template/en/default/extensions/name-readme.txt.tmpl b/template/en/default/extensions/name-readme.txt.tmpl new file mode 100644 index 000000000..6d25c839e --- /dev/null +++ b/template/en/default/extensions/name-readme.txt.tmpl @@ -0,0 +1,38 @@ +[%# 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 + #%] + +[% PROCESS global/variables.none.tmpl %] + +Normal templates go in this directory. You can load them in your +code like this: + +use B[% %]ugzilla::Error; +my $template = B[% %]ugzilla->template; +$template->process('[% name FILTER lower %]/some-template.html.tmpl') + or ThrowTemplateError($template->error()); + +That would be how to load a file called some-template.html.tmpl that +was in this directory. + +Note that you have to be careful that the full path of your template +never conflicts with a template that exists in [% terms.Bugzilla %] or in +another extension, or your template might override that template. That's why +we created this directory called '[% name FILTER lower %]' for you, so you +can put your templates in here to help avoid conflicts. diff --git a/template/en/default/extensions/util.pm.tmpl b/template/en/default/extensions/util.pm.tmpl new file mode 100644 index 000000000..e197e8177 --- /dev/null +++ b/template/en/default/extensions/util.pm.tmpl @@ -0,0 +1,42 @@ +[%# -*- mode: perl -*- %] +[%# 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 + #%] + +[%# INTERFACE: + # name: string; The name of the extension. + #%] + +[% PROCESS global/variables.none.tmpl %] + +[% PROCESS extensions/license.txt.tmpl %] + +package B[% %]ugzilla::Extension::[% name %]; +use strict; +use base qw(Exporter); +our @EXPORT = qw( + +); + +# This file can be loaded by your extension via +# "use B[% %]ugzilla::Extension::[% name %]::Util". You can put functions +# used by your extension in here. (Make sure you also list them in +# @EXPORT.) + +1; diff --git a/template/en/default/global/messages.html.tmpl b/template/en/default/global/messages.html.tmpl index bc6ca5601..1f63da79b 100644 --- a/template/en/default/global/messages.html.tmpl +++ b/template/en/default/global/messages.html.tmpl @@ -279,7 +279,12 @@ The request to change the email address for the account [%+ old_email FILTER html %] to [%+ new_email FILTER html %] has been canceled. - Your old account settings have been reinstated. + Your old account settings have been reinstated. + + [% ELSIF message_tag == "extension_created" %] + An extension named [% name FILTER html %] has been created + in [% path FILTER html %]. Make sure you change "YOUR NAME" and + "YOUR EMAIL ADDRESS" in the code to your name and your email address. [% ELSIF message_tag == "field_value_created" %] [% title = "New Field Value Created" %] diff --git a/template/en/default/global/user-error.html.tmpl b/template/en/default/global/user-error.html.tmpl index 230f029b5..144e2e7ea 100644 --- a/template/en/default/global/user-error.html.tmpl +++ b/template/en/default/global/user-error.html.tmpl @@ -17,6 +17,7 @@ # # Contributor(s): Gervase Markham # Frédéric Buclin + # Max Kanat-Alexander #%] [%# INTERFACE: @@ -32,10 +33,10 @@ # in this file; if you do not wish to change it, use the "none" filter. # # Extension- or custom-specific error handling can be easily added - # via hooks: just place your -errors.html.tmpl into - # template/en/extension/hook/global/user-error.html.tmpl/errors/ - # Note: be aware of uniqueness of error string parameter value, since - # nobody can guarantee the hook files processing order in the future + # via hooks: just place additional code into + # template/en/hook/global/user-error-errors.html.tmpl + # Note: be aware of uniqueness of error string parameter value, since + # nobody can guarantee the hook files processing order in the future. #%] [% PROCESS global/variables.none.tmpl %] @@ -428,6 +429,13 @@ does not exist or you aren't authorized to enter [% terms.abug %] into it. + [% ELSIF error == "extension_create_no_name" %] + You must specify a name for your extension, as an argument to this script. + + [% ELSIF error == "extension_first_letter_caps" %] + The first letter of your extension's name must be a capital letter. + (You specified '[% name FILTER html %]'.) + [% ELSIF error == "field_already_exists" %] [% title = "Field Already Exists" %] The field '[% field.name FILTER html %]' -- cgit v1.2.1