Command Line WebGUI Graham Knop

Transcription

1 Command Line WebGUI Graham Knop

2 Command Line WebGUI System administrators Automating tasks Working across multiple servers Developers Using the API directly Using the site and code from the same interface

3 Utility Scripts upgrade.pl userimport.pl fileimport.pl rebuildlineage.pl search.pl and others

4 Utility Scripts Problems Lots of boilerplate Many WebGUI APIs aren t ideal for command line use Assume a lot about the state of a site - may not apply for dev work Speed can be an issue

5 WGDev Meant as a replacement for some past scripts Largest most important command initially - reset Grew to cover more ground

6 WGDev Options All commands and options are documented Most commands need a config file and WebGUI root directory $ wgd -h Run WGDev commands Usage: wgd [arguments] <subcommand> [subcommand arguments] Options: -h -? --help Display usage summary for any command -V --version Display version information -F --config-file Specify WebGUI config file to use -S --sitename Specify the name of a WebGUI site to operate on -R --webgui-root Specify WebGUI's root directory <subcommand> The sub-command to run or get help for

7 WGDev Options: WebGUI Root WEBGUI_ROOT environment variable -R / --webgui-root command line options command.webgui_root WGDev config setting From a fully qualified config file path Searching upward in the directory tree

8 WGDev Options: WebGUI Config WEBGUI_CONFIG environment variable -F / --webgui-config command line options command.webgui_config WGDev config setting WEBGUI_SITENAME environment variable -S / --sitename command line options

9 WGDev Commands build commands config db dist edit export guid help import intro ls mail optimize package reset run setting test user util version

10 WGDev Commands build commands config db dist edit export guid help import intro ls mail Connect to site with optimize mysql client package reset run setting test user util version

11 WGDev Commands build commands Import or export config packages db dist edit export guid help import intro ls mail optimize package reset run setting test user util version

12 WGDev Commands build commands config db dist Set or edit retrieve settings export guid help import intro ls mail optimize package reset run setting test user util version

13 WGDev Commands build commands config db dist edit export guid help import intro ls mail optimize package reset run setting test user util version

14 WGDev Commands: Db Connect to the site database using the MySQL client $ wgd db -h Connect to database with the MySQL client Usage: wgd db [-p -d -l -c --show] [mysql options] Options: Any arguments not recognized will be passed through to the mysql or mysqldump commands as applicable. -p --print Prints out the command options that would be passed to mysql -d --dump= Dumps the database as an SQL script -l --load= Loads a database script into the database -c --clear Clears the database, removing all tables --show Shows database information via mysqlshow

15 WGDev Commands: Reset $ wgd reset -h Reset a site to defaults Usage: wgd reset [-v] [-q] [-f] [-d -b -t] Options: -v --verbose Output more information -q --quiet Output less information -f --fast Fast mode - equivalent to: --no-upload --no-backup --no-delcache --no-purge --no-cleantags --no-index --no-runwf -t --test Test mode - equivalent to: --backup --import -d --dev Developer mode - equivalent to: --backup --import --no-starter --debug --clear --upgrade --uploads -b --build Build mode - equivalent to: --verbose --backup --import --starter --no-debug --upgrade --purge --cleantags --index --runwf --[no-]backup Backup database before doing any other operations --[no-]delcache Delete the site's cache --[no-]import Import a database script --[no-]uploads Recreate uploads directory...

16 WGDev Commands: Reset wgd reset -d : Full reset in dev mode Disables the site starter Enables debug mode Clears most content from the front page $ wgd reset -d Backing up current database... Done. Clearing cache... Done. Recreating uploads... Done Clearing old database information... Done. Importing clean database dump... Done Running upgrade script... Done Setting WebGUI settings... Done Clearing example assets... Done

17 WGDev Commands: Reset wgd reset -b : Full reset in build mode Sets up the site for export to create.sql Shows full upgrade detail Purges old asset revisions Combines everything into one version tag Empties the trash Rebuilds lineage and search index

18 WGDev Commands: Reset $ wgd reset -b Backing up current database... Done. Clearing cache... Done. Recreating uploads... Done Clearing old database information... Done. Importing clean database dump... Done Running upgrade script......full upgrade output... Done Setting WebGUI settings... Done Purging old Asset revisions... Purging Folder... Done Emptying trash... Done Finding current version number Done Cleaning out versions Tags... Done Running all pending workflows... Done Rebuilding lineage... Done Rebuilding search index... Done 'Survey'

19 WGDev Commands: Reset wgd reset --autologon: Automatically log in as admin Reads your browser cookies, looking for a pre-existing session for the site Creates a new session on the site with that ID Sets the user for the created session to the Admin user

20 WGDev Commands: Reset wgd reset --profile: Use a saved set of options Option string is set in the WGDev config file

21 WGDev Commands: Reset $ wgd config command.reset.profiles.d --dev --autologon --no-backup $ wgd reset -pd Clearing cache... Done. Recreating uploads... Done. Clearing old database information... Done. Importing clean database dump... Done. Running upgrade script... Done. Setting WebGUI settings... Done. Clearing example assets... Done. Getting active browser site sessions... Done. Creating sessions on site... Done.

22 WGDev Commands: Reset wgd reset --config: Reset site config file Recreates the site s config file using WebGUI.conf.original Copies some values from the existing config Additional items to copy or always set can be set in the WGDev config file

23 WGDev Commands: Reset Always copied: dsn dbuser dbpass uploadspath uploadsurl exportpath extraspath extrasurl cachetype sitename spectreip spectreport spectresubnets filecacheroot

24 WGDev Commands: Edit Edit assets through a command line editor $ wgd edit -h Edits assets by URL Usage: wgd edit [--command=<command>] <asset> [<asset>...] wgd edit --tree=<asset> [--tree=<asset>...] [--class=<class>...] Options: --command= <asset> --tree= --class= Command to be executed Either an asset URL, ID, or class name Will open specified asset and all descendants in editor Only used with --tree option

25 WGDev Commands: Edit $ wgd edit layout.css 1 ==== Snippet ====================================================== 2 Asset ID : VyCINX2KixKYr2pzQGX9Mg 3 Menu Title : layout.css 4 Parent : root/import/layout 5 Title : layout.css 6 URL : layout.css 7 ==== snippet ======================================================= 8 /*/ styles for the layout asset /*/ 9.wg-left { 10 float: left; 11 } 12.wg-right { 13 float: right; 14 } 15.wg-clear { 16 clear: both; 17 } 18.sidebyside.wg-content-position,.oneovertwo.wg-content-position { 19 width: 49%; :wq Updating: layout.css (VyCINX2KixKYr2pzQGX9Mg) layou...

26 WGDev Commands: Edit --command option allows batch processing $ wgd edit --command='perl -pi -e"s/float: left/float: right/"' \ > layout.css article.css Updating: layout.css (VyCINX2KixKYr2pzQGX9Mg) layou... Skipping: article.css (zb_opknqctuijdvvbekrjw) artic... WGDev Commands: Ls $ wgd ls root/import/layout side_by_side right_column default_page one_over_three plainblacknews layout.css one_over_two

27 WGDev Commands: For-Each Runs a given command across multiple config files $ wgd for-each -h Run command for each available config file Usage: wgd for-each [ --print0 --exec=command ] [ -f ] Options: -f --force Continue processing config files if there is an error -0 --print0[=format] Prints the config file name followed by an ASCII NUL character instead of a carriage return -p --print[=format] Prints the config file name -e --exec= Runs the given command using the shell for each config file -w -c --wgd= Runs the given WGDev command for each config file

28 WGDev Commands: For-Each $ wgd for-each -p -w'package -i layout.css.wgpkg' /Users/gknop/src/WebGUI/etc/ Imported 'layout.css.wgpkg' to layout.css /Users/gknop/src/WebGUI/etc/ Imported 'layout.css.wgpkg' to layout.css

29 WGDev Commands: Util Runs a WebGUI utility script $ wgd util -h Run a utility script Usage: wgd util [-q] <command> Options: Any options not handled by this command are passed to the utility script. -q --quiet If specified, will silence all output from the utility script

30 WGDev Commands: Help $ wgd help db WGDev::Command::Db(3) User Contributed Perl DocumentationWGDev::Command::Db (3) NAME WGDev::Command::Db - Connect to database with the MySQL client SYNOPSIS wgd db [-p -d -l -c --show] [mysql options] DESCRIPTION Opens the "mysql" client to your WebGUI database, loads or dumps a database script, or displays database information, or clears a database's contents. OPTIONS Any arguments not recognized will be passed through to the "mysql" or "mysqldump" commands as applicable.... "-p" "--print" Prints out the command options that would be passed to "mysql"

31 Writing WGDev Commands Copy ex/command.pm Set package name Implement main methods process config_options Write POD Used for usage docs

32 package WGDev::Command::Example; use strict; use warnings; use ; our $VERSION = '0.0.1'; use WGDev::Command::Base; BEGIN { = qw(wgdev::command::base) } sub config_options { return qw( all A ); } sub process { my $self = shift; my $wgd = $self->wgd; if ( $self->option('all') ) { print "Doing everything.\n"; } else { print "Doing something.\n"; } return 1; } 1;

33 package WGDev::Command:: use strict; use warnings; use ; our $VERSION = '0.0.1'; use WGDev::Command::Base; BEGIN { = qw(wgdev::command::base) } sub config_options { return qw( } ); sub process { my $self = shift; } return 1; 1;

34 package WGDev::Command::Tags; use strict; use warnings; use ; our $VERSION = '0.0.1'; use WGDev::Command::Base; BEGIN { = qw(wgdev::command::base) } sub config_options { return qw( limit l=i ); } sub process { my $self = shift; require WebGUI::VersionTag; my $limit = $self->option('limit') 20; my $tags = WebGUI::VersionTag->getOpenTags($self->wgd->session); for my $tag (@$tags) { last if $limit-- == 0; print $tag->get('name'). "\n"; } return 1; } 1;

35 END =head1 NAME WGDev::Command::Example - Example WGDev Command =head1 SYNOPSIS wgd example [-A] =head1 DESCRIPTION This is a sample command. =head1 OPTIONS =over 8 =item C<-A> C<--all> Does everything. =back =head1 AUTHOR Graham Knop <haarg@haarg.org>...

36 END =head1 NAME WGDev::Command:: =head1 SYNOPSIS wgd =head1 DESCRIPTION =head1 OPTIONS =over 8 =back =head1 AUTHOR Graham Knop <haarg@haarg.org>...

37 END =head1 NAME WGDev::Command::Tags - Show information about version tags =head1 SYNOPSIS wgd tags [-l limit] =head1 DESCRIPTION Show information about version tags. =head1 OPTIONS =over 8 =item C<-l> C<--limit=> Limits the number of tags to show. Defaults to 20 if not specified. =back =head1 AUTHOR Graham Knop <haarg@haarg.org>...

38 $ wgd tags -h Show information about version tags Usage: wgd tags [-l limit] Options: -l --limit= Limits the number of tags to show $ wgd tags Admin / 8/30/ :12 pm (Autotag) Admin / 8/30/ :11 pm (Autotag) Admin / 8/30/ :11 pm (Autotag) Admin / 8/30/ :38 am (Autotag) $ wgd tags -l2 Admin / 8/30/ :12 pm (Autotag) Admin / 8/30/ :11 pm (Autotag)

39 Getting WGDev wget && chmod +x wgd wgd self-upgrade

40 WebGUI 8: WebGUI::Command New API changes make some core parts of WGDev less important Other parts of WGDev can just be added into WebGUI WebGUI::Command will replace most of WGDev and all of WebGUI s included utility scripts

41 WebGUI::Command Built on App::Cmd Similar design to WGDev s command dispatching system Eliminates a lot of the previously needed code WebGUI::Paths, WebGUI::Site, WebGUI::Session, and PSGI changes integrate other WGDev ideas and eliminate the need for other parts

42 WebGUI::Command single entry point: webgui.pl commands are modules $ sbin/webgui.pl upgrade --doit Upgrading localhost.conf (site 1/1): Running upgrades for (step 1/1): Backing up to /var/folders/lj/ljnghmzlgp0w1qxubpkyce+++ti/-tmp-/backups/ localhost.conf_7.9.5_ sql Moving preload files... Done. Migrating to new cache... Done. Moving preload files... Done. Moving maintenance file... Done. Upgrades complete. Please restart your web server and test your sites.

43 WebGUI::Command::upgrade package WebGUI::Command::upgrade; use WebGUI::Command -command; use strict; use warnings; use WebGUI::Paths; use WebGUI::Upgrade; sub opt_spec { return ( [ 'history', Display upgrade history for a site ], [ 'override', Force upgrade to run even if not. running as root ], [ 'quiet', Don't show progress reports ], [ 'doit', Run upgrade ], [ 'skipdelete', Don't clear cache ], [ 'skipmaintenance', Don't turn on maintenance mode for. sites while upgrading ], [ 'skipbackup', Don't create database backups ], [ 'backupdir=s', Directory to store database backups ], [ 'mysql=s', mysql command line client to use ], [ 'mysqldump=s', mysqldump command line client to use ], ); }

44 sub validate_args { my $self = shift; my $opt = shift; my $args = shift; if ($opt->{history}) { return; } elsif (! $opt->{doit}) { $self->usage_error(<<'end_message'); W A R N I N G... END_MESSAGE } elsif ( $^O ne 'MSWin32' && $>!= 0 &&!$opt->{override} ) { $self->usage_error('you must be the super user to use this utility.'); } } sub run { my ($self, $opt, $args) if ($opt->{history}) { $self->show_history($opt, $args); } else { $self->run_upgrade($opt, $args); } }

45 sub run_upgrade { my ($self, $opt, $args) my $upgrade = WebGUI::Upgrade->new( quiet => $opt->{quiet}, clearcache =>! $opt->{skipdelete}, createbackups =>! $opt->{skipbackup}, usemaintenancemode =>! $opt->{skipmaintenance}, $opt->{mysql}? ( mysql => $opt->{mysql}, ) : (), $opt->{mysqldump}? ( mysqldump => $opt->{mysqldump}, ) : (), $opt->{backupdir}? ( backuppath => $opt->{backupdir}, ) : (), ); $upgrade->upgradesites; STOP } print <<STOP; Upgrades complete. Please restart your web server and test your sites.

46 sub show_history { my $self = shift; for my $config (WebGUI::Paths->siteConfigs) { print "$config:\n"; WebGUI::Upgrade->reportHistory($config); print "\n"; } }

47 Command Line WebGUI Questions / Comments?