Skip to content

Commit

Permalink
Item576: Initial checkin / release of WebAutoIncPlugin
Browse files Browse the repository at this point in the history 
git-svn-id: http://svn.foswiki.org/trunk/WebAutoIncPlugin@1614 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
OliverKrueger authored and OliverKrueger committed Dec 27, 2008
0 parents commit 815b093
Show file tree
Hide file tree
Showing 5 changed files with 284 additions and 0 deletions.
44 changes: 44 additions & 0 deletions data/System/WebAutoIncPlugin.txt
@@ -0,0 +1,44 @@
---+!! !WebAutoIncPlugin
<!--
One line description, required for extensions repository catalog.
* Set SHORTDESCRIPTION = Alternative to bin/manage?action=createweb. Adds AUTOINC feature.
-->
%SHORTDESCRIPTION%

%TOC%

This is a simple wrapper for the traditional =bin/manage?action=createweb= call, which
just adds the AUTOINC feature known from topics. It is implemented RESTfully.

WebAutoIncPlugin is most useful for application developers.

---++ Usage

| *Parameter* | *Description* | *Default* |
| =newweb= | Name of the new web. May include a =AUTOINC0= suffix. | '' |
| =baseweb= | Name of the web to copy to create the new web | '' |
| =webbgcolor= | value for WEBBGCOLOR | '' |
| =sitemapwhat= | Value for SITEMAPWHAT | '' |
| =sitemapuseto= | Value for SITEMAPUSETO | '' |
| =nosearchall= | Value for NOSEARCHALL | '' |
| =redirectto= | reserved for future use | '' |

---++ Examples
* %SCRIPTURL{rest}%/WebAutoIncPlugin/create?newweb=Sandbox.BoxAUTOINC0 creates a new Box web (as a subweb of Sandbox) with increasing numbers as suffix.

---++ Installation Instructions

%$INSTALL_INSTRUCTIONS%

---++ Info

| Author(s): | Foswiki:Main.OliverKrueger |
| Copyright: | &copy; 2008, Foswiki:Main.OliverKrueger, Wiki-One |
| License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
| Version: | 2008-12-27 |
| Change History: | <!-- versions below in reverse order -->&nbsp; |
| 27 Dec 2008: | initial release |
| Dependencies: | %$DEPENDENCIES% |
| Home page: | http://foswiki.org/Extensions/WebAutoIncPlugin |

<!-- Do _not_ attempt to edit this topic; it is auto-generated. -->
207 changes: 207 additions & 0 deletions lib/Foswiki/Plugins/WebAutoIncPlugin.pm
@@ -0,0 +1,207 @@
# Plugin for Foswiki - The Free and Open Source Wiki, http://foswiki.org/
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details, published at
# http://www.gnu.org/copyleft/gpl.html

package Foswiki::Plugins::WebAutoIncPlugin;

# Always use strict to enforce variable scoping
use strict;

require Foswiki::Func; # The plugins API
require Foswiki::Plugins; # For the API version

our $VERSION = '$Rev: 1340 $';
our $RELEASE = '2008-12-27';
our $SHORTDESCRIPTION = 'Alternative to bin/manage?action=createweb. Adds AUTOINC feature.';
our $NO_PREFS_IN_TOPIC = 1;

sub initPlugin {
my( $topic, $web, $user, $installWeb ) = @_;

# check for Plugins.pm versions
if( $Foswiki::Plugins::VERSION < 2.0 ) {
Foswiki::Func::writeWarning( 'Version mismatch between ',
__PACKAGE__, ' and Plugins.pm' );
return 0;
}

Foswiki::Func::registerRESTHandler( 'create', \&restCreate );

# Plugin correctly initialized
return 1;
}

sub _getWebname {
my $newWeb = $_[0];

# stolen from Foswiki::UI::Save::save
if ( $newWeb =~ /AUTOINC([0-9]+)/ ) {
my $start = $1;
my $baseWeb = $newWeb;
my $nameFilter = $newWeb;
$nameFilter =~ s/AUTOINC([0-9]+)/([0-9]+)/;
my @list =
sort { $a <=> $b }
map { s/^$nameFilter$/$1/; s/^0*([0-9])/$1/; $_ }
grep { /^$nameFilter$/ } Foswiki::Func::getListOfWebs();
if ( scalar @list ) {

# find last one, and increment by one
my $next = $list[$#list] + 1;
my $len = length($start);
$start =~ s/^0*([0-9])/$1/; # cut leading zeros
$next = $start if ( $start > $next );
my $pad = $len - length($next);
if ( $pad > 0 ) {
$next = '0' x $pad . $next; # zero-pad
}
$newWeb =~ s/AUTOINC[0-9]+/$next/;
}
else {

# first auto-inc topic
$newWeb =~ s/AUTOINC[0-9]+/$start/;
}
}
return $newWeb;
}

sub createWeb {
my ( $theNewWeb, $theBaseWeb, $opts ) = @_;

$theNewWeb = _getWebname($theNewWeb);
Foswiki::Func::createWeb( $theNewWeb, $theBaseWeb, $opts );

return "$theNewWeb";
}

sub restCreate {
my ($session) = @_;

my $webRE = Foswiki::Func::getRegularExpression('webNameRegex');
my $query = $session->{cgiQuery};

# newweb param
my $theNewWeb = "";
if ( $query->param('newweb') =~ m/^($webRE)$/o ) { $theNewWeb = $1; }
unless ($theNewWeb) {
print CGI::header(
-status => "500 newweb parameter missing or invalid." )
;
print "\n\n";
print "<h1> newweb parameter missing or invalid. </h1>";
return 0;
}

# baseweb param
my $theBaseWeb = "";
if ( $query->param('baseweb') =~ m/^([a-z0-9\.\/_]+)$/oi ) {
$theBaseWeb = $1;
}
unless ($theBaseWeb) {
print CGI::header(
-status => "500 baseweb parameter missing or invalid." );
print "\n\n";
print "<h1> baseweb parameter missing or invalid. </h1>";
return 0;
}

my $opts;

# webbgcolor param
if ( defined( $query->param('webbgcolor') ) ) {
if ( $query->param('webbgcolor') =~ m/^([A-Za-z0-9#]+)$/o ) {
$opts->{"WEBBGCOLOR"} = $1;
}
}
elsif ( defined( $query->param('WEBBGCOLOR') ) ) {
if ( $query->param('WEBBGCOLOR') =~ m/^([A-Za-z0-9#]+)$/o ) {
$opts->{"WEBBGCOLOR"} = $1;
}
}

# sitemapwhat param
if ( defined( $query->param('sitemapwhat') ) ) {
if ( $query->param('sitemapwhat') =~ m/^(.*)$/o ) {
$opts->{"SITEMAPWHAT"} = $1;
}
}
elsif ( defined( $query->param('SITEMAPWHAT') ) ) {
if ( $query->param('SITEMAPWHAT') =~ m/^(.*)$/o ) {
$opts->{"SITEMAPWHAT"} = $1;
}
}

# sitemapuseto param
if ( defined( $query->param('sitemapuseto') ) ) {
if ( $query->param('sitemapuseto') =~ m/^(.*)$/o ) {
$opts->{"SITEMAPUSETO"} = $1;
}
}
elsif ( defined( $query->param('SITEMAPUSETO') ) ) {
if ( $query->param('SITEMAPUSETO') =~ m/^(.*)$/o ) {
$opts->{"SITEMAPUSETO"} = $1;
}
}

# nosearchall param
if ( defined( $query->param('nosearchall') ) ) {
if ( $query->param('nosearchall') =~ m/^(on|off)$/oi ) {
$opts->{"NOSEARCHALL"} = $1;
}
}
elsif ( defined( $query->param('NOSEARCHALL') ) ) {
if ( $query->param('NOSEARCHALL') =~ m/^(on|off)$/oi ) {
$opts->{"NOSEARCHALL"} = $1;
}
}

# # redirectto param
# # will be added in the near future
# if ( defined( $query->param('redirectto') ) ) {
# if ( $query->param('redirectto') =~ m/^(.*)$/o ) {
# }
# }

use Error qw( :try );
use Foswiki::AccessControlException;

try {
createWeb( $theNewWeb, $theBaseWeb, $opts );
}
catch Error::Simple with {
my $e = shift;
print CGI::header( -status => "500 " . $e->stringify() );
print "\n\n" . $e->stringify();
return 0;
}
catch Foswiki::AccessControlException with {
my $e = shift;
print CGI::header( -status => "500 " . $e->stringify() );
print "\n\n" . $e->stringify();
return 0;
};

return "$theNewWeb\n\n";
}

1;
__END__
This copyright information applies to the WebAutoIncPlugin:
# Plugin for Foswiki - The Free and Open Source Wiki, http://foswiki.org/
#
# WebAutoIncPlugin is # This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
#
# For licensing info read LICENSE file in the Foswiki root.
5 changes: 5 additions & 0 deletions lib/Foswiki/Plugins/WebAutoIncPlugin/DEPENDENCIES
@@ -0,0 +1,5 @@
# Dependencies for WebAutoIncPlugin
# Example:
# Time::ParseDate,>=2003.0211,cpan,Required.
# Foswiki::Plugins,>=1.2,perl,Requires version 1.2 of handler API.

4 changes: 4 additions & 0 deletions lib/Foswiki/Plugins/WebAutoIncPlugin/MANIFEST
@@ -0,0 +1,4 @@
# Release manifest for WebAutoIncPlugin
data/System/WebAutoIncPlugin.txt 0644 Documentation
lib/Foswiki/Plugins/WebAutoIncPlugin.pm 0644 Perl module

24 changes: 24 additions & 0 deletions lib/Foswiki/Plugins/WebAutoIncPlugin/build.pl
@@ -0,0 +1,24 @@
#!/usr/bin/perl -w
BEGIN { unshift @INC, split( /:/, $ENV{FOSWIKI_LIBS} ); }
use Foswiki::Contrib::Build;

# Create the build object
$build = new Foswiki::Contrib::Build('WebAutoIncPlugin');

# (Optional) Set the details of the repository for uploads.
# This can be any web on any accessible Foswiki installation.
# These defaults will be used when expanding tokens in .txt
# files, but be warned, they can be overridden at upload time!

# name of web to upload to
$build->{UPLOADTARGETWEB} = 'Extensions';
# Full URL of pub directory
$build->{UPLOADTARGETPUB} = 'http://foswiki.org/pub';
# Full URL of bin directory
$build->{UPLOADTARGETSCRIPT} = 'http://foswiki.org/bin';
# Script extension
$build->{UPLOADTARGETSUFFIX} = '';

# Build the target on the command line, or the default target
$build->build($build->{target});

0 comments on commit 815b093

Please sign in to comment.