lfscmd/src/lfscmd.c

   1 /*
   2  * Copyright (C) 2003 Timothy Bauscher <timothy@linuxfromscratch.org>
   3 */
   4
   5 #include <stdio.h>
   6 #include <regex.h>
   7 #include <sys/stat.h>
   8 #include <unistd.h>
   9 #include <stdlib.h>
  10
  11 #include "help.h"
  12 #include "env.h"
  13 #include "string.h"
  14 #include "file.h"
  15 #include "lfscmd.h"
  16
  17 struct LFSCMD options;
  18
  19 int lfscmd (int argc, char **argv)
  20 {
  21     xmlDocPtr doc;
  22     xmlNodePtr node;
  23     int c;
  24     char* xmlfile;
  25
  26     /* Set defaults */
  27     options.exe       = 0;
  28     options.execute   = 0;
  29     options.file      = 0;
  30     options.title     = 0;
  31     options.strip_amp = 0;
  32     options.query   = NULL;
  33     //options.xmlfile = NULL;
  34
  35     while ((c = getopt (argc, argv, "fxteq:a")) != -1)
  36         switch (c)
  37         {
  38         case 'f':
  39             options.file = 1;
  40             break;
  41         case 'x':
  42             options.exe = 1;
  43             break;
  44         case 't':
  45             options.title = 1;
  46             break;
  47         case 'e':
  48             options.execute = 1;
  49             break;
  50         case 'q':
  51             options.query = optarg;
  52             break;
  53         case 'a':
  54             options.strip_amp = 1;
  55             break;
  56         case '?':
  57         default:
  58             help(argv[0]);
  59         }
  60
  61     /* Get xml file path */
  62     xmlfile = argv[optind];
  63
  64     /* Validate arguments */
  65     if (NULL == xmlfile
  66         && NULL == (xmlfile=locate_book("LFSCMD_BOOK")))
  67         help(argv[0]);
  68
  69     /* Setup the xml parser */
  70     xmlSubstituteEntitiesDefault(1);
  71     doc = xmlParseFile(xmlfile);
  72     node = xmlDocGetRootElement(doc);
  73
  74     /* Check that the document is well-formed */
  75     if (NULL == doc) error("Document not well-formed");
  76     /* Check for an empty root element */
  77     if (NULL == node) error("Empty root element");
  78
  79     return(lfscmd_parsexml("unknown", "unknown", doc, node->children));
  80 }
  81
  82 int lfscmd_parsexml (char* sect, char* fname, xmlDocPtr doc, xmlNodePtr node)
  83 {
  84     regex_t reg;
  85     FILE *output = stdout;
  86     int title_shown = 0;
  87
  88     /* Compile regex query */
  89     if (NULL != options.query)
  90     {
  91         if (regcomp(&reg, options.query, REG_NOSUB))
  92             error("Regex is ill-formed: %s", options.query);
  93     }
  94
  95     while (NULL != node)
  96     {
  97         /* Record page title */
  98         if (string_comp("title", node->name))
  99         {
 100             sect = xmlNodeListGetString(doc, node->children, 1);
 101             title_shown = 0;
 102         }
 103         /* Determine filename by section id */
 104         else if (string_comp("part", node->name)
 105                  || (string_len(node->name) >= 4
 106                      && string_comp("sect", string_snip(node->name, 0, 4))))
 107         {
 108             if (NULL != xmlGetProp(node, "id"))
 109                 fname = xmlGetProp(node, "id");
 110
 111         }
 112         /* Display screen commands */
 113         else if (string_comp("screen", node->name)
 114                  && string_comp("userinput", node->children->name))
 115         {
 116             /* Match title or section with query */
 117             if (NULL != options.query)
 118             {
 119                 if (!regexec(&reg, sect, 0, NULL, 0)
 120                     || !regexec(&reg, fname, 0, NULL, 0))
 121                 {
 122                     /* Append output to file */
 123                     if (options.file)
 124                         output=write_file(fname, "a");
 125
 126                     /* Output new page title */
 127                     if (options.title && !title_shown)
 128                     {
 129                         fprintf(output, "\n\n### %s: %s ###\n", fname, sect);
 130                         title_shown = 1;
 131                     }
 132                     lfscmd_parse_screen(output, doc, node->children);
 133                 }
 134             }
 135             else
 136             {
 137                 /* Append output to file */
 138                 if (options.file)
 139                     output=write_file(fname, "a");
 140
 141                 /* Output new page title */
 142                 if (options.title && !title_shown)
 143                 {
 144                     fprintf(output, "\n\n### %s: %s ###\n", fname, sect);
 145                     title_shown = 1;
 146                 }
 147                 lfscmd_parse_screen(output, doc, node->children);
 148             }
 149             /* Close file */
 150             if (options.file)
 151             {
 152                 fclose(output);
 153
 154                 /* Make file executable */
 155                 if (options.exe)
 156                     chmod(fname, 00755);
 157             }
 158         }
 159
 160         /* Recursively traverse the tree */
 161         if (NULL != node->children)
 162             lfscmd_parsexml(sect, fname, doc, node->children);
 163
 164         node = node->next;
 165     }
 166     return(0);
 167 }
 168
 169 static void output_cmd(FILE* output, char* cmd)
 170 {
 171     if (options.execute)
 172         system(options.strip_amp ? string_strip(cmd, " &&") : cmd);
 173     else
 174         fprintf(output, "%s", options.strip_amp ? string_strip(cmd, " &&") : cmd);
 175 }
 176
 177 int lfscmd_parse_command(FILE* output, xmlDocPtr doc, xmlNodePtr node)
 178 {
 179     char* cmd;
 180
 181     while (NULL != node)
 182     {
 183         /* Output content outside of "command" */
 184         if (string_comp("text", node->name))
 185         {
 186             if (NULL != (cmd = node->content))
 187             {
 188                 output_cmd(output, cmd);
 189             }
 190         }
 191
 192         if (NULL != (cmd = xmlNodeListGetString(doc, node->children, 1)))
 193         {
 194             output_cmd(output, cmd);
 195         }
 196
 197         node = node->next;
 198     }
 199     return 1;
 200 }
 201
 202 int lfscmd_parse_userinput(FILE* output, xmlDocPtr doc, xmlNodePtr node)
 203 {
 204     char* cmd;
 205
 206     /* Output userinput commands and content */
 207     while (NULL != node)
 208     {
 209         /* Properly deal with BLFS commands of the form <screen><userinput><command> */
 210         if (string_comp("command", node->name))
 211         {
 212             lfscmd_parse_command(output, doc, node->children);
 213         }
 214         else if (NULL != (cmd = xmlNodeListGetString(doc, node, 1)))
 215         {
 216             output_cmd(output, cmd);
 217         }
 218
 219         node = node->next;
 220     }
 221
 222     return 1;
 223 }
 224
 225 int lfscmd_parse_screen (FILE* output, xmlDocPtr doc, xmlNodePtr node)
 226 {
 227     char* cmd;
 228
 229     /* Output screen commands and content */
 230     while (NULL != node)
 231     {
 232         /* Output content outside of "userinput" */
 233         if (string_comp("text", node->name))
 234         {
 235             if (NULL != (cmd = node->content))
 236             {
 237                 output_cmd(output, cmd);
 238             }
 239         }
 240
 241         /* Output commands */
 242         else if (string_comp("userinput", node->name))
 243         {
 244             lfscmd_parse_userinput(output, doc, node->children);
 245         }
 246
 247         node = node->next;
 248     }
 249
 250     /* Output trailing space */
 251     fprintf(output, "\n");
 252
 253     return(1);
 254 }
 255