scripts/core/generate_aliases.pl

   1 #!/usr/bin/perl
   2
   3 ##############
   4 #
   5 #  Name   : generate_aliases
   6 #  Author : Chris Koeritz
   7 #  Rights : Copyright (C) 1996-$now by Author
   8 #
   9 #  Purpose:
  10 #
  11 #    This script generates feisty meow script alias files.  Alias files
  12 #  contain a list of definitions for command aliases that are written in the
  13 #  specified shell dialect (such as bash or perl) and which are additionally
  14 #  tailored for the operating system to be used.
  15 #
  16 ##############
  17 #  This program is free software; you can redistribute it and/or modify it
  18 #  under the terms of the GNU General Public License as published by the Free
  19 #  Software Foundation; either version 2 of the License or (at your option)
  20 #  any later version.  See: "http://www.gruntose.com/Info/GNU/GPL.html" for a
  21 #  version of the License.  Please send any updates to "fred@gruntose.com".
  22 ##############
  23
  24 require "filename_helper.pl";
  25
  26 use Env qw(FEISTY_MEOW_BINARIES BUILD_TOP FEISTY_MEOW_APEX FEISTY_MEOW_LOADING_DOCK FEISTY_MEOW_SCRIPTS DEBUG_FEISTY_MEOW HOME );
  27
  28 # given a possible aliasable filename, this will decide whether to create a perl
  29 # or bash alias for it.  it needs the filename of the possible alias and the
  30 # directory where that file resides.
  31 sub make_alias {
  32   local($file, $dir) = @_;
  33   if ($file =~ /\.[pP][lL]$/) {
  34     local($aliasname) = $file; $aliasname =~ s/\.[Pp][lL]$//;
  35     &make_perl_alias($aliasname, "$dir");
  36   } elsif ($file =~ /\.[sS][hH]$/) {
  37     local($aliasname) = $file; $aliasname =~ s/\.[Ss][Hh]$//;
  38     &make_bash_alias($aliasname, "$dir");
  39   }
  40 }
  41
  42 # makes an alias for a bash script given the alias name.
  43 sub make_bash_alias {
  44   local($aliasname) = shift(@_);
  45   local($full_alias) = $aliasname;
  46 #print "full alias is $full_alias\n";
  47   $aliasname =~ s/^.*\/([^\/]*)/\1/;
  48 #print "alias became $aliasname\n";
  49   print she "define_yeti_alias $aliasname=\"bash $full_alias.sh\"\n";
  50 }
  51
  52 # makes an alias for a perl script given the alias name.
  53 sub make_perl_alias {
  54   local($aliasname) = shift(@_);
  55   local($full_alias) = $aliasname;
  56   $aliasname =~ s/^.*\/([^\/]*)/\1/;
  57 #print "alias became $aliasname\n";
  58   print she "define_yeti_alias $aliasname=\"perl $full_alias.pl\"\n";
  59 }
  60
  61 ##############
  62
  63 # The "common.alias" file is used in the generated aliases file as a base
  64 # set of generally useful aliases.  We also add aliases for any script files
  65 # (perl, bash, python, etc) that we find in the feisty meow script hierarchy.
  66 # Any *.alias files found in the $FEISTY_MEOW_LOADING_DOCK/custom folder are
  67 # loaded also.
  68 sub rebuild_script_aliases {
  69
  70   if (length($DEBUG_FEISTY_MEOW)) {
  71     print "rebuilding generated aliases file...\n";
  72   }
  73
  74   # create our generated shells directory if it's not already.
  75   if ( ! -d $FEISTY_MEOW_LOADING_DOCK ) {
  76     mkdir $FEISTY_MEOW_LOADING_DOCK;
  77     if (length($DEBUG_FEISTY_MEOW)) {
  78       print "made FEISTY_MEOW_LOADING_DOCK at '$FEISTY_MEOW_LOADING_DOCK'\n";
  79     }
  80   }
  81
  82   # test if we can use color in ls...
  83 #  $test_color=` ls --help 2>&1 | grep -i color `;
  84
  85   # this is an array of files from which to draw alias definitions.
  86   @ALIAS_DEFINITION_FILES = ("$FEISTY_MEOW_SCRIPTS/core/common.alias");
  87
  88   # if custom aliases files exist, add them to the list.
  89 #hmmm: would be nice to have this name in a symbol somewhere instead of having "custom" or "customize" everywhere.
  90   foreach $i (&glob_list("$FEISTY_MEOW_LOADING_DOCK/custom/*.alias")) {
  91     if (-f $i) { push(@ALIAS_DEFINITION_FILES, $i); }
  92   }
  93   if (length($DEBUG_FEISTY_MEOW)) {
  94     print "using these alias files:\n";
  95 #print "HEY IS THIS PROBLEM CHILD?\n";
  96     foreach $i (@ALIAS_DEFINITION_FILES) {
  97       local $base_of_dir = &basename(&dirname($i));
  98       local $basename = &basename($i);
  99       print "  $base_of_dir/$basename\n";
 100     }
 101 #print "WAS PROBLEM CHILD ABOVE HERE?\n";
 102   }
 103
 104   # write the aliases for sh and bash scripts.
 105
 106   local $GENERATED_ALIAS_FILE = "$FEISTY_MEOW_LOADING_DOCK/fmc_core_and_custom_aliases.sh";
 107   if (length($DEBUG_FEISTY_MEOW)) {
 108     print "writing generated aliases in $GENERATED_ALIAS_FILE...\n";
 109   }
 110
 111 #hmmm: perhaps a good place for a function to create the header,
 112 #      given the appropriate comment code.
 113
 114   open GENOUT, ">$GENERATED_ALIAS_FILE" or die "cannot open $GENERATED_ALIAS_FILE";
 115
 116   print GENOUT "##\n";
 117   print GENOUT "## generated file: $GENERATED_ALIAS_FILE\n";
 118   print GENOUT "## please do not edit.\n";
 119   print GENOUT "##\n";
 120
 121 #  if (length($test_color)) {
 122 #    print GENOUT "export color_add='--color=auto'\n";
 123 #  } else {
 124 #    print GENOUT "export color_add=\n";
 125 #  }
 126
 127   # plow in the full set of aliases into the file.
 128   foreach $i (@ALIAS_DEFINITION_FILES) {
 129     open CURR_ALIASER, "<$i" or die "cannot open current alias file $i";
 130     foreach $line (<CURR_ALIASER>) {
 131       print GENOUT "$line";
 132     }
 133   }
 134
 135   close GENOUT;
 136
 137   if (length($DEBUG_FEISTY_MEOW)) {
 138     print("done rebuilding generated aliases file.\n");
 139   }
 140 }
 141
 142 ##############
 143
 144 # make sure we know where to store the files we're creating.
 145 if ( ! length("$FEISTY_MEOW_LOADING_DOCK") ) {
 146   print "\
 147 The FEISTY_MEOW_LOADING_DOCK variable is not defined.  This must point to\
 148 the location where the generated scripts are stored.  You may still need to\
 149 configure the feisty meow script system with something like:\
 150   bash /opt/feistymeow.org/feisty_meow/scripts/core/reconfigure_feisty_meow.sh\
 151 Please see http://feistymeow.org for more details.\n";
 152   exit 1;
 153 #really need to use better exit codes.
 154 }
 155
 156 ##############
 157
 158 $FEISTY_MEOW_LOADING_DOCK =~ s/\\/\//g;
 159 $FEISTY_MEOW_SCRIPTS =~ s/\\/\//g;
 160 $FEISTY_MEOW_APEX =~ s/\\/\//g;
 161
 162 ##############
 163
 164 # create our generated shells directory if it's not already there.
 165 if (! -d $FEISTY_MEOW_LOADING_DOCK) {
 166   mkdir $FEISTY_MEOW_LOADING_DOCK;
 167 }
 168
 169 ##############
 170
 171 # set the executable bit for binaries for just this current user.
 172 if (-d $FEISTY_MEOW_BINARIES) {
 173   system("find \"$FEISTY_MEOW_BINARIES\" -type f -exec chmod u+x \"{}\" ';'");
 174 }
 175
 176 ##############
 177
 178 # generate the first set of alias files that are defined in the core
 179 # and custom scripts directories.
 180 &rebuild_script_aliases;
 181
 182 ##############
 183
 184 # trash the old versions.
 185 unlink("$FEISTY_MEOW_LOADING_DOCK/fmc_aliases_for_scripts.sh");
 186
 187 if (length($DEBUG_FEISTY_MEOW)) {
 188   printf "writing $FEISTY_MEOW_LOADING_DOCK/fmc_aliases_for_scripts.sh...\n";
 189 }
 190
 191 ##############
 192
 193 # open the alias files to be created.
 194 open(she, ">> $FEISTY_MEOW_LOADING_DOCK/fmc_aliases_for_scripts.sh");
 195
 196 # find the list of files in the scripts directory.
 197 @shell_files = (find_files(recursive_find_directories("$FEISTY_MEOW_SCRIPTS")),
 198     find_files("$FEISTY_MEOW_LOADING_DOCK/custom/scripts"),
 199     find_files(recursive_find_directories("$FEISTY_MEOW_LOADING_DOCK/custom/scripts")));
 200
 201 # strip out the customization files, since they are added in on demand only.
 202 #print "before filtering list: @shell_files\n";
 203 @shell_files = grep ! /\/customize\//, @shell_files;
 204 #print "after filtering list: @shell_files\n";
 205
 206 #printf "found all these files in main script dirs:\n";
 207 #printf "  @shell_files\n";
 208
 209 # construct aliases for items in the scripts directory.
 210 foreach $file (@shell_files) {
 211   # test to see what type of item we got.
 212   if ($file =~ '^\.$'
 213       || $file =~ '^\.\.$'
 214       || $file =~ '^.svn$'
 215       || $file =~ '^.git$'
 216       || $file =~ /\/\.$/
 217       || $file =~ /\/\.\.$/
 218       || $file =~ /\/\.svn$/
 219       || $file =~ /\/\.git$/
 220       ) {
 221     # just skip this item; it's a special directory or a file we don't want to include.
 222     print "skipping name: $file\n";
 223   } else {
 224      &make_alias($file, "");
 225   }
 226 }
 227
 228 close(she);
 229
 230 ##############
 231
 232 # prepare a finalizer chunk that is the last thing to load.
 233
 234 open(she, ">> $FEISTY_MEOW_LOADING_DOCK/fmc_ending_sentinel.sh");
 235
 236 # write in our sentinel alias that says alias loading was handled.
 237 print she "define_yeti_alias CORE_ALIASES_LOADED=true\n";
 238
 239 close(she);
 240
 241 ##############
 242
 243 1;
 244