[1466] | 1 | #!/usr/bin/perl -w
|
---|
| 2 | #
|
---|
| 3 | =head1 NAME
|
---|
| 4 |
|
---|
| 5 | cbusterize - Creates the correct CasparBuster structure in your CMS environment
|
---|
| 6 |
|
---|
| 7 | =head1 SYNOPSIS
|
---|
| 8 |
|
---|
[1468] | 9 | cbusterize [options] --source /path/to/file/to/CasparBusterize
|
---|
[1466] | 10 |
|
---|
| 11 | Options:
|
---|
| 12 | --debug |-d debug mode
|
---|
| 13 | --help |-h brief help message
|
---|
| 14 | --man full documentation
|
---|
[1485] | 15 | --force |-f force copy of files, even if they exist
|
---|
| 16 | --source |-s <file/dir> directory or files to copy in the CasparBuster tree (',' separated if many)
|
---|
| 17 | --plugin |-p <plugin name> plugin defining what to copy in the CasparBuster tree (',' separated if many)
|
---|
[1466] | 18 | --machine|-m <machine> machine to consider in the subtree
|
---|
| 19 |
|
---|
| 20 | =head1 OPTIONS
|
---|
| 21 |
|
---|
| 22 | =over 4
|
---|
| 23 |
|
---|
| 24 | =item B<--debug>
|
---|
| 25 |
|
---|
| 26 | Enter debug mode. This will print what would be done. No commands are executed,
|
---|
| 27 | so this is safe to use when testing.
|
---|
| 28 |
|
---|
| 29 | =item B<--help>
|
---|
| 30 |
|
---|
| 31 | Print a brief help message and exits.
|
---|
| 32 |
|
---|
| 33 | =item B<--man>
|
---|
| 34 |
|
---|
| 35 | Prints the manual page and exits.
|
---|
| 36 |
|
---|
| 37 | =item B<--machine> I<machine name>
|
---|
| 38 |
|
---|
| 39 | Specify the machine to consider when dealing with the CasparBuster structure.
|
---|
| 40 | The file will be taken from this machine, and a subdirectory named after the machine
|
---|
| 41 | will be used under the basedir to host the directory structure to manage
|
---|
| 42 |
|
---|
| 43 | =item B<--source> I<path>
|
---|
| 44 |
|
---|
[1485] | 45 | Specify the path to the source file or directory to manage with CasparBuster. Multiple paths can be specified separated by ','.
|
---|
[1466] | 46 |
|
---|
[1485] | 47 | =item B<--plugin> I<name>
|
---|
| 48 |
|
---|
| 49 | Specify the name of the plugin to manage with CasparBuster. Multiple plugins can be specified separated by ','.
|
---|
| 50 | A plugin defines a set of files (with their mode and owner), a set of directories (with their mode and owner) and a set of scripts to launch once the files are copied remotely.
|
---|
| 51 |
|
---|
[1466] | 52 | =back
|
---|
| 53 |
|
---|
| 54 | =head1 DESCRIPTION
|
---|
| 55 |
|
---|
| 56 | Creates a directory under the machine dir passed as parameter in working
|
---|
| 57 | directory or directory passed as parameter named like the last path
|
---|
| 58 | element of the parameter, and creates the standard CasparBuster setup
|
---|
| 59 | that refers to the parameter path in the new directory, and configuration
|
---|
| 60 | files when possible. It also copies the original config file into the new dir.
|
---|
| 61 | Is reasonably picky about path names, tries to avoid common errors.
|
---|
| 62 |
|
---|
| 63 | Schema looks like:
|
---|
| 64 |
|
---|
| 65 | Base dir
|
---|
| 66 | |
|
---|
| 67 | |- machine1 (optional)
|
---|
| 68 | | |
|
---|
| 69 | | |-- conf dir1
|
---|
| 70 | | | |
|
---|
| 71 | | | |- conf file 1
|
---|
| 72 | | [...] [...]
|
---|
| 73 | |
|
---|
| 74 | |- machine2 (optional)
|
---|
| 75 | | |
|
---|
| 76 | | |-- conf dir2
|
---|
| 77 | | | |
|
---|
| 78 | | | |- conf file 2
|
---|
| 79 | | [...] [...]
|
---|
| 80 |
|
---|
| 81 | Use of machines require use of option -m (if using cbusemachines in cb.conf)
|
---|
| 82 | If not, the conf dirs are directly attached to the base dir
|
---|
| 83 |
|
---|
| 84 | =head1 EXAMPLES
|
---|
| 85 |
|
---|
| 86 | # this will create the appropriate CasparBuster environment
|
---|
| 87 | # under the base ~/prj/musique-ancienne.org directory (Cf cbbasedir in cb.conf)
|
---|
| 88 | # containing the directory victoria2 for this machine
|
---|
| 89 | # under which it will copy the required structure if needed (/etc/ssh)
|
---|
| 90 | # to finaly put a copy of the file sshd_conf in it from the victoria2 machine
|
---|
| 91 |
|
---|
| 92 | cbusterize -m victoria2 -s /etc/ssh/sshd_config
|
---|
| 93 |
|
---|
| 94 | =head1 AUTHOR
|
---|
| 95 |
|
---|
| 96 | =over 4
|
---|
| 97 |
|
---|
| 98 | Bruno Cornec, http://brunocornec.wordpress.com
|
---|
| 99 |
|
---|
| 100 | =back
|
---|
| 101 |
|
---|
| 102 | =head1 LICENSE
|
---|
| 103 |
|
---|
| 104 | Copyright (C) 2012 Bruno Cornec <bruno@project-builder.org>
|
---|
| 105 | Released under the GPLv2 or the Artistic license at your will.
|
---|
| 106 |
|
---|
| 107 | =cut
|
---|
| 108 | use strict;
|
---|
[1468] | 109 | use CasparBuster::Version;
|
---|
| 110 | use CasparBuster::Env;
|
---|
[1485] | 111 | use CasparBuster::Plugin;
|
---|
[1466] | 112 | use File::Basename;
|
---|
| 113 | use File::Path;
|
---|
| 114 | use Getopt::Long;
|
---|
| 115 | use Pod::Usage;
|
---|
[1468] | 116 | use Data::Dumper;
|
---|
[1494] | 117 | use Net::SSH2;
|
---|
[1466] | 118 | use ProjectBuilder::Base;
|
---|
| 119 | use ProjectBuilder::Conf;
|
---|
[1470] | 120 | use ProjectBuilder::VCS;
|
---|
[1466] | 121 |
|
---|
| 122 | # settings
|
---|
| 123 | my $debug = 0;
|
---|
[1468] | 124 | my $help = undef;
|
---|
| 125 | my $man = undef;
|
---|
[1466] | 126 | my $source = undef;
|
---|
| 127 | my $machine = undef;
|
---|
[1468] | 128 | my $plugin = undef;
|
---|
[1466] | 129 | my $quiet = undef;
|
---|
[1485] | 130 | my $force = undef;
|
---|
[1466] | 131 | my $log = undef;
|
---|
| 132 | my $LOG = undef;
|
---|
| 133 |
|
---|
[1468] | 134 | my ($cbver,$cbrev) = cb_version_init();
|
---|
[1466] | 135 | my $appname = "cb";
|
---|
| 136 | $ENV{'PBPROJ'} = $appname;
|
---|
| 137 | pb_temp_init();
|
---|
| 138 |
|
---|
| 139 | # Initialize the syntax string
|
---|
| 140 | pb_syntax_init("$appname (aka CasparBuster) Version $cbver-$cbrev\n");
|
---|
| 141 |
|
---|
| 142 | # parse command-line options
|
---|
| 143 | GetOptions(
|
---|
| 144 | 'machine|m=s' => \$machine,
|
---|
| 145 | 'debug|d+' => \$debug,
|
---|
| 146 | 'help|h' => \$help,
|
---|
| 147 | 'quiet|q' => \$quiet,
|
---|
[1485] | 148 | 'force|f' => \$force,
|
---|
[1466] | 149 | 'man' => \$man,
|
---|
[1485] | 150 | 'logfile|l=s' => \$log,
|
---|
[1466] | 151 | 'source|s=s' => \$source,
|
---|
[1468] | 152 | 'plugin|p=s' => \$plugin,
|
---|
[1466] | 153 | ) || pb_syntax(-1,0);
|
---|
| 154 |
|
---|
| 155 | if (defined $help) {
|
---|
| 156 | pb_syntax(0,1);
|
---|
| 157 | }
|
---|
| 158 | if (defined $man) {
|
---|
| 159 | pb_syntax(0,2);
|
---|
| 160 | }
|
---|
| 161 | if (defined $quiet) {
|
---|
| 162 | $debug=-1;
|
---|
| 163 | }
|
---|
| 164 | if (defined $log) {
|
---|
| 165 | open(LOG,"> $log") || die "Unable to log to $log: $!";
|
---|
| 166 | $LOG = \*LOG;
|
---|
| 167 | $debug = 0 if ($debug == -1);
|
---|
| 168 | }
|
---|
[1468] | 169 |
|
---|
| 170 | $pbdebug = $debug;
|
---|
[1466] | 171 | pb_log_init($debug, $LOG);
|
---|
| 172 | pb_log(0,"Starting cbusterize\n");
|
---|
| 173 |
|
---|
| 174 | # Get conf file in context
|
---|
| 175 | pb_conf_init($appname);
|
---|
[1468] | 176 | # The personal one if there is such
|
---|
| 177 | pb_conf_add("$ENV{'HOME'}/.cbrc") if (-f "$ENV{'HOME'}/.cbrc");
|
---|
[1466] | 178 | # The system one
|
---|
| 179 | pb_conf_add(cb_env_conffile());
|
---|
| 180 |
|
---|
| 181 | # Get configuration parameters
|
---|
[1468] | 182 | my %cb;
|
---|
| 183 | my $cb = \%cb;
|
---|
[1485] | 184 | ($cb->{'basedir'},$cb->{'usemachines'},$cb->{'cms'}) = pb_conf_get("cbbasedir","cbusemachines","cbcms");
|
---|
[1470] | 185 | pb_log(2,"%cb: ",Dumper($cb));
|
---|
[1466] | 186 |
|
---|
| 187 | # Check for mandatory params
|
---|
[1468] | 188 | pod2usage("Error: --source or --plugin is a mandatory argument\n") if ((not defined $source) && (not defined $plugin));
|
---|
| 189 | pod2usage("Error: --machine is a mandatory argument when configure with cbusemachines = true\n") if (($cb->{'usemachines'}->{$appname} =~ /true/) && (not defined $machine));
|
---|
[1466] | 190 |
|
---|
[1468] | 191 | if (defined $plugin) {
|
---|
[1485] | 192 | # Load plugins
|
---|
| 193 | cb_plugin_load();
|
---|
[1468] | 194 | }
|
---|
[1466] | 195 |
|
---|
[1468] | 196 | my $basedir = $cb->{'basedir'}->{$appname};
|
---|
| 197 | eval { $basedir =~ s/(\$ENV.+\})/$1/eeg };
|
---|
| 198 |
|
---|
[1485] | 199 | pb_log(1, "DEBUG MODE, not doing anything, just printing\nDEBUG: basedir = $basedir\n");
|
---|
| 200 | pb_log(1, "DEBUG: source = $source\n") if (defined $source);
|
---|
| 201 | pb_log(1, "DEBUG: machine = $machine\n") if (defined $machine);
|
---|
[1466] | 202 |
|
---|
[1485] | 203 | # Use potentially a remote account if defined
|
---|
| 204 | my $account = undef;
|
---|
[1494] | 205 | my $remote = undef;
|
---|
[1485] | 206 | ($account) = pb_conf_get_if("cbaccount") if (defined $machine);
|
---|
[1494] | 207 | $remote = $account->{$machine} if ((defined $account) && (defined $machine) && (defined $account->{$machine}));
|
---|
| 208 | pb_log(1, "DEBUG: remote account1 = $remote\n") if (defined $remote);
|
---|
| 209 | $remote = getpwuid($<) if (not defined $remote);
|
---|
| 210 | pb_log(1, "DEBUG: remote account2 = $remote\n");
|
---|
[1485] | 211 |
|
---|
[1466] | 212 | # Create basedir if it doesn't exist
|
---|
| 213 | if (not -d $basedir) {
|
---|
| 214 | if ($debug) {
|
---|
[1470] | 215 | pb_log(1, "DEBUG: Creating recursively directory $basedir\n");
|
---|
[1466] | 216 | } else {
|
---|
[1485] | 217 | pb_mkdir_p($basedir) || die "Unable to recursively create $basedir: $!";
|
---|
[1466] | 218 | }
|
---|
| 219 | }
|
---|
| 220 |
|
---|
[1485] | 221 | if (defined $source) {
|
---|
| 222 | foreach my $f (split(/,/,$source)) {
|
---|
[1494] | 223 | cb_busterize($f,"true");
|
---|
[1485] | 224 | }
|
---|
| 225 | }
|
---|
| 226 |
|
---|
| 227 | # Now handle plugins if any
|
---|
| 228 | my $cbp = ();
|
---|
| 229 |
|
---|
| 230 | if (defined $plugin) {
|
---|
| 231 | foreach my $p (split(/,/,$plugin)) {
|
---|
| 232 | pb_log(1,"Getting context for plugin $p\n");
|
---|
| 233 | $cbp = cb_plugin_get($p,$cbp);
|
---|
| 234 | pb_log(2,"cbp: ".Dumper($cbp)."\n");
|
---|
[1494] | 235 | foreach my $k (keys %{$cbp->{$plugin}->{'dirsandfiles'}}) {
|
---|
| 236 | cb_busterize($k,"true");
|
---|
[1485] | 237 | }
|
---|
[1494] | 238 | foreach my $k ((keys %{$cbp->{$plugin}->{'dirs'}}),(keys %{$cbp->{$plugin}->{'files'}})) {
|
---|
| 239 | cb_busterize($k,"false");
|
---|
| 240 | }
|
---|
[1485] | 241 | }
|
---|
| 242 | }
|
---|
| 243 |
|
---|
| 244 | sub cb_busterize {
|
---|
| 245 |
|
---|
| 246 | my $source = shift;
|
---|
[1494] | 247 | my $recur = shift;
|
---|
[1485] | 248 |
|
---|
| 249 | pb_log(2,"Entering cb_busterize source: $source\n");
|
---|
[1466] | 250 | # Is the source a file or a dir ? Split the source parameter in 2
|
---|
| 251 | my $srcdir = undef;
|
---|
| 252 | my $srcfile = undef;
|
---|
[1485] | 253 | my $cmd = undef;
|
---|
[1494] | 254 | my $ssh2;
|
---|
| 255 | my $sftp;
|
---|
[1485] | 256 |
|
---|
| 257 | if (not defined $machine) {
|
---|
| 258 | if (-d $source) {
|
---|
| 259 | $srcdir = $source;
|
---|
| 260 | } else {
|
---|
| 261 | $srcdir = dirname($source);
|
---|
| 262 | $srcfile = basename($source);
|
---|
| 263 | }
|
---|
[1466] | 264 | } else {
|
---|
[1494] | 265 | $ssh2 = Net::SSH2->new();
|
---|
| 266 | $ssh2->connect($machine);
|
---|
| 267 | my $hdir = (getpwnam(getpwuid($<)))[7];
|
---|
| 268 | if ($ssh2->auth_publickey($remote,"$hdir/.ssh/id_dsa.pub","$hdir/.ssh/id_dsa")) {
|
---|
| 269 | $sftp = $ssh2->sftp;
|
---|
| 270 | my %dirs = $sftp->stat("$source/.");
|
---|
| 271 | my $res = 0;
|
---|
| 272 | $res = -1 if (not defined $dirs{'mode'});
|
---|
| 273 | pb_log(2,"DEBUG: Found res = $res\n");
|
---|
| 274 | if ($res == 0) {
|
---|
| 275 | $srcdir = $source;
|
---|
| 276 | pb_log(1,"DEBUG: Found remote dir = $source\n");
|
---|
| 277 | } else {
|
---|
| 278 | $srcdir = dirname($source);
|
---|
| 279 | $srcfile = basename($source);
|
---|
| 280 | pb_log(1,"DEBUG: Found remote file = $source\n");
|
---|
| 281 | }
|
---|
[1466] | 282 | }
|
---|
[1485] | 283 | }
|
---|
[1466] | 284 |
|
---|
[1470] | 285 | pb_log(1,"DEBUG: Found srcdir = $srcdir\n");
|
---|
| 286 | if (defined $srcfile) {
|
---|
| 287 | pb_log(1,"DEBUG: Found srcfile = $srcfile\n");
|
---|
| 288 | } else {
|
---|
| 289 | pb_log(1,"DEBUG: Found no srcfile\n");
|
---|
[1466] | 290 | }
|
---|
| 291 |
|
---|
[1468] | 292 | # Deduce the target directory from the local structure and the source
|
---|
| 293 | my $target = $basedir;
|
---|
| 294 | $target .= "/$machine" if defined ($machine);
|
---|
| 295 | $target .= "$srcdir";
|
---|
[1466] | 296 |
|
---|
[1470] | 297 | my $scheme = $cb->{'cms'}->{$appname};
|
---|
| 298 |
|
---|
[1466] | 299 | # If both source and target are dirs, then copy into the parent of the target
|
---|
| 300 | $target = basename($target) if ((not defined $srcfile) && (-d $target));
|
---|
| 301 |
|
---|
[1494] | 302 | # Create target if it doesn't exist
|
---|
| 303 | if (not -d $target) {
|
---|
[1468] | 304 | if ($debug) {
|
---|
[1470] | 305 | pb_log(1,"DEBUG: Creating recursively directory $target\n");
|
---|
[1466] | 306 | } else {
|
---|
[1485] | 307 | pb_mkdir_p($target) || die "Unable to recursively create $target: $!";
|
---|
[1466] | 308 | }
|
---|
[1494] | 309 | # Add all the dirs in it to VCS (in reverse order)
|
---|
| 310 | my $tdir = $target;
|
---|
| 311 | my @tab = ();
|
---|
| 312 | while ($tdir ne $basedir) {
|
---|
| 313 | push(@tab,$tdir);
|
---|
| 314 | $tdir = dirname($tdir);
|
---|
| 315 | pb_log(3,"tdir is now $tdir\n");
|
---|
| 316 | }
|
---|
| 317 | if ($debug) {
|
---|
| 318 | pb_log(0,"INFO: Added to your $scheme system the dirs: ".join(' ',reverse(@tab))."\n");
|
---|
| 319 | } else {
|
---|
| 320 | pb_vcs_add($scheme,reverse(@tab));
|
---|
| 321 | }
|
---|
[1466] | 322 | }
|
---|
| 323 |
|
---|
| 324 | # We need to know where to get the content from
|
---|
| 325 | my $cmdopt = "";
|
---|
| 326 |
|
---|
| 327 | # Recursive if we copy dirs
|
---|
| 328 | $cmdopt = "-r" if (not defined $srcfile);
|
---|
| 329 |
|
---|
| 330 | if (defined $machine) {
|
---|
[1494] | 331 | $cmd = "scp -p -q $cmdopt $remote\@$machine:\'$source\' $target";
|
---|
[1466] | 332 | } else {
|
---|
| 333 | $cmd = "cp -p $cmdopt $source $target";
|
---|
| 334 | }
|
---|
[1468] | 335 |
|
---|
[1466] | 336 | # Now add content if not already there
|
---|
[1470] | 337 | if (defined $srcfile) {
|
---|
| 338 | # File case
|
---|
[1494] | 339 | if ((! -f "$target/$srcfile") || (defined $force)) {
|
---|
[1470] | 340 | if ($debug) {
|
---|
| 341 | pb_log(1,"DEBUG: launching $cmd\n");
|
---|
| 342 | } else {
|
---|
| 343 | pb_system($cmd);
|
---|
| 344 | pb_vcs_add($scheme,"$target/$srcfile");
|
---|
| 345 | pb_log(0,"INFO: Created $target/$srcfile and added it to your $scheme system\n");
|
---|
| 346 | }
|
---|
| 347 | } else {
|
---|
| 348 | pb_log(0,"INFO: File $target/$srcfile already there\n");
|
---|
| 349 | }
|
---|
| 350 | } else {
|
---|
| 351 | # Directory case
|
---|
[1466] | 352 | if ($debug) {
|
---|
[1494] | 353 | if ($recur eq "true") {
|
---|
| 354 | pb_log(1,"DEBUG: launching $cmd\n");
|
---|
| 355 | } else {
|
---|
| 356 | pb_log(1,"DEBUG: mkdir -p $target\n");
|
---|
| 357 | }
|
---|
[1466] | 358 | } else {
|
---|
[1494] | 359 | if ($recur eq "true") {
|
---|
| 360 | pb_system($cmd);
|
---|
| 361 | }
|
---|
[1470] | 362 | pb_vcs_add($scheme,"$target");
|
---|
| 363 | pb_log(0,"INFO: Created $target and added it to your $scheme system\n");
|
---|
[1466] | 364 | }
|
---|
| 365 | }
|
---|
[1494] | 366 | $ssh2->disconnect() if (defined $machine);
|
---|
[1485] | 367 | pb_log(2,"Exiting cb_busterize\n");
|
---|
| 368 | }
|
---|