webgui/docs/upgrades/upgrade_7.10.3-7.10.4.pl

#!/usr/bin/env perl

#-------------------------------------------------------------------
# WebGUI is Copyright 2001-2009 Plain Black Corporation.
#-------------------------------------------------------------------
# Please read the legal notices (docs/legal.txt) and the license
# (docs/license.txt) that came with this distribution before using
# this software.
#-------------------------------------------------------------------
# http://www.plainblack.com                     info@plainblack.com
#-------------------------------------------------------------------

our ($webguiRoot);

BEGIN {
    $webguiRoot = "../..";
    unshift (@INC, $webguiRoot."/lib");
}

use strict;
use Getopt::Long;
use WebGUI::Session;
use WebGUI::Storage;
use WebGUI::Asset;
use List::Util qw(first);

my $toVersion = '7.10.4';
my $quiet; # this line required


my $session = start(); # this line required

# upgrade functions go here
changeTemplateHelpUrl($session);
addForkTable($session);
installForkCleanup($session);

finish($session); # this line required


#----------------------------------------------------------------------------
# Describe what our function does
#sub exampleFunction {
#    my $session = shift;
#    print "\tWe're doing some stuff here that you should know about... " unless $quiet;
#    # and here's our code
#    print "DONE!\n" unless $quiet;
#}

#----------------------------------------------------------------------------
# Describe what our function does
sub changeTemplateHelpUrl {
    my $session = shift;
    print "\tChange the URL for the template that displays help variables... " unless $quiet;
    # and here's our code
    my $template = WebGUI::Asset->newByDynamicClass($session, 'PBtmplHelp000000000001');
    if ($template) {
        $template->update({url => 'root/import/adminconsole/help'});
        my $rs = $template->session->db->read("select revisionDate from assetData where assetId=? and revisionDate<>?",[$template->getId, $template->get("revisionDate")]);
        while (my ($version) = $rs->array) {
            my $old = WebGUI::Asset->new($session, $template->getId, $template->get("className"), $version);
            $old->purgeRevision if defined $old;
        }
    }
    else {
        print "\n\tNO TEMPLATE FOR DISPLAYING TEMPLATE VARIABLES...";
    }
    print "DONE!\n" unless $quiet;
}

#----------------------------------------------------------------------------
# Creates a new table for tracking background processes
sub addForkTable {
    my $session = shift;
    my $db      = $session->db;
    my $sth     = $db->dbh->table_info('', '', 'Fork', 'TABLE');
    return if ($sth->fetch);
    print "\tAdding Fork table..." unless $quiet;
    my $sql = q{
        CREATE TABLE Fork (
            id        CHAR(22),
            userId    CHAR(22),
            groupId   CHAR(22),
            status    LONGTEXT,
            error     TEXT,
            startTime BIGINT(20),
            endTime   BIGINT(20),
            finished  BOOLEAN DEFAULT FALSE,
            latch     BOOLEAN DEFAULT FALSE,

            PRIMARY KEY(id)
        );
    };
    $db->write($sql);
    print "DONE!\n" unless $quiet;
}

#----------------------------------------------------------------------------
# install a workflow to clean up old background processes
sub installForkCleanup {
    my $session = shift;
    print "\tInstalling Fork Cleanup workflow..." unless $quiet;
    my $class = 'WebGUI::Workflow::Activity::RemoveOldForks';
    $session->config->addToArray('workflowActivities/None', $class);
    my $wf = WebGUI::Workflow->new($session, 'pbworkflow000000000001');
    my $a  = first { ref $_ eq $class } @{ $wf->getActivities };
    unless ($a) {
        $a = $wf->addActivity($class);
        $a->set(title => 'Remove Old Forks');
    };
    print "DONE!\n" unless $quiet;
}


# -------------- DO NOT EDIT BELOW THIS LINE --------------------------------

#----------------------------------------------------------------------------
# Add a package to the import node
sub addPackage {
    my $session     = shift;
    my $file        = shift;

    print "\tUpgrading package $file\n" unless $quiet;
    # Make a storage location for the package
    my $storage     = WebGUI::Storage->createTemp( $session );
    $storage->addFileFromFilesystem( $file );

    # Import the package into the import node
    my $package = eval {
        my $node = WebGUI::Asset->getImportNode($session);
        $node->importPackage( $storage, {
            overwriteLatest    => 1,
            clearPackageFlag   => 1,
            setDefaultTemplate => 1,
        } );
    };

    if ($package eq 'corrupt') {
        die "Corrupt package found in $file.  Stopping upgrade.\n";
    }
    if ($@ || !defined $package) {
        die "Error during package import on $file: $@\nStopping upgrade\n.";
    }

    return;
}

#-------------------------------------------------
sub start {
    my $configFile;
    $|=1; #disable output buffering
    GetOptions(
        'configFile=s'=>\$configFile,
        'quiet'=>\$quiet
    );
    my $session = WebGUI::Session->open($webguiRoot,$configFile);
    $session->user({userId=>3});
    my $versionTag = WebGUI::VersionTag->getWorking($session);
    $versionTag->set({name=>"Upgrade to ".$toVersion});
    return $session;
}

#-------------------------------------------------
sub finish {
    my $session = shift;
    updateTemplates($session);
    my $versionTag = WebGUI::VersionTag->getWorking($session);
    $versionTag->commit;
    $session->db->write("insert into webguiVersion values (".$session->db->quote($toVersion).",'upgrade',".time().")");
    $session->close();
}

#-------------------------------------------------
sub updateTemplates {
    my $session = shift;
    return undef unless (-d "packages-".$toVersion);
    print "\tUpdating packages.\n" unless ($quiet);
    opendir(DIR,"packages-".$toVersion);
    my @files = readdir(DIR);
    closedir(DIR);
    my $newFolder = undef;
    foreach my $file (@files) {
        next unless ($file =~ /\.wgpkg$/);
        # Fix the filename to include a path
        $file       = "packages-" . $toVersion . "/" . $file;
        addPackage( $session, $file );
    }
}

#vim:ft=perl