[thirdparty/cups.git] / cgi-bin / help.c

/*
 * Online help CGI for CUPS.
 *
 * Copyright 2007-2011 by Apple Inc.
 * Copyright 1997-2006 by Easy Software Products.
 *
 * Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
 */

/*
 * Include necessary headers...
 */

#include "cgi-private.h"


/*
 * 'main()' - Main entry for CGI.
 */

int					/* O - Exit status */
main(int  argc,				/* I - Number of command-line arguments */
     char *argv[])			/* I - Command-line arguments */
{
  help_index_t	*hi,			/* Help index */
		*si;			/* Search index */
  help_node_t	*n;			/* Current help node */
  int		i;			/* Looping var */
  const char	*query;			/* Search query */
  const char	*cache_dir;		/* CUPS_CACHEDIR environment variable */
  const char	*docroot;		/* CUPS_DOCROOT environment variable */
  const char	*helpfile,		/* Current help file */
		*helptitle = NULL;	/* Current help title */
  const char	*topic;			/* Current topic */
  char		topic_data[1024];	/* Topic form data */
  const char	*section;		/* Current section */
  char		filename[1024],		/* Filename */
		directory[1024];	/* Directory */
  cups_file_t	*fp;			/* Help file */
  char		line[1024];		/* Line from file */
  int		printable;		/* Show printable version? */


 /*
  * Get any form variables...
  */

  cgiInitialize();

  printable = cgiGetVariable("PRINTABLE") != NULL;

 /*
  * Set the web interface section...
  */

  cgiSetVariable("SECTION", "help");
  cgiSetVariable("REFRESH_PAGE", "");

 /*
  * Load the help index...
  */

  if ((cache_dir = getenv("CUPS_CACHEDIR")) == NULL)
    cache_dir = CUPS_CACHEDIR;

  snprintf(filename, sizeof(filename), "%s/help.index", cache_dir);

  if ((docroot = getenv("CUPS_DOCROOT")) == NULL)
    docroot = CUPS_DOCROOT;

  snprintf(directory, sizeof(directory), "%s/help", docroot);

  fprintf(stderr, "DEBUG: helpLoadIndex(filename=\"%s\", directory=\"%s\")\n",
          filename, directory);

  hi = helpLoadIndex(filename, directory);
  if (!hi)
  {
    perror(filename);

    cgiStartHTML(cgiText(_("Online Help")));
    cgiSetVariable("ERROR", cgiText(_("Unable to load help index.")));
    cgiCopyTemplateLang("error.tmpl");
    cgiEndHTML();

    return (1);
  }

  fprintf(stderr, "DEBUG: %d nodes in help index...\n",
          cupsArrayCount(hi->nodes));

 /*
  * See if we are viewing a file...
  */

  for (i = 0; i < argc; i ++)
    fprintf(stderr, "DEBUG: argv[%d]=\"%s\"\n", i, argv[i]);

  if ((helpfile = getenv("PATH_INFO")) != NULL)
  {
    helpfile ++;

    if (!*helpfile)
      helpfile = NULL;
  }

  if (helpfile)
  {
   /*
    * Verify that the help file exists and is part of the index...
    */

    snprintf(filename, sizeof(filename), "%s/help/%s", docroot, helpfile);

    fprintf(stderr, "DEBUG: helpfile=\"%s\", filename=\"%s\"\n",
            helpfile, filename);

    if (access(filename, R_OK))
    {
      perror(filename);

      cgiStartHTML(cgiText(_("Online Help")));
      cgiSetVariable("ERROR", cgiText(_("Unable to access help file.")));
      cgiCopyTemplateLang("error.tmpl");
      cgiEndHTML();

      return (1);
    }

    if ((n = helpFindNode(hi, helpfile, NULL)) == NULL)
    {
      cgiStartHTML(cgiText(_("Online Help")));
      cgiSetVariable("ERROR", cgiText(_("Help file not in index.")));
      cgiCopyTemplateLang("error.tmpl");
      cgiEndHTML();

      return (1);
    }

   /*
    * Save the page title and help file...
    */

    helptitle = n->text;
    topic     = n->section;

   /*
    * Send a standard page header...
    */

    if (printable)
      puts("Content-Type: text/html;charset=utf-8\n");
    else
      cgiStartHTML(n->text);
  }
  else
  {
   /*
    * Send a standard page header...
    */

    cgiStartHTML(cgiText(_("Online Help")));

    topic = cgiGetVariable("TOPIC");
  }

 /*
  * Do a search as needed...
  */

  if (cgiGetVariable("CLEAR"))
    cgiSetVariable("QUERY", "");

  query = cgiGetVariable("QUERY");
  si    = helpSearchIndex(hi, query, topic, helpfile);

  cgiClearVariables();
  if (query)
    cgiSetVariable("QUERY", query);
  if (topic)
    cgiSetVariable("TOPIC", topic);
  if (helpfile)
    cgiSetVariable("HELPFILE", helpfile);
  if (helptitle)
    cgiSetVariable("HELPTITLE", helptitle);

  fprintf(stderr, "DEBUG: query=\"%s\", topic=\"%s\"\n",
          query ? query : "(null)", topic ? topic : "(null)");

  if (si)
  {
    help_node_t	*nn;			/* Parent node */


    fprintf(stderr,
            "DEBUG: si=%p, si->sorted=%p, cupsArrayCount(si->sorted)=%d\n", si,
            si->sorted, cupsArrayCount(si->sorted));

    for (i = 0, n = (help_node_t *)cupsArrayFirst(si->sorted);
         n;
	 i ++, n = (help_node_t *)cupsArrayNext(si->sorted))
    {
      if (helpfile && n->anchor)
        snprintf(line, sizeof(line), "#%s", n->anchor);
      else if (n->anchor)
        snprintf(line, sizeof(line), "/help/%s?QUERY=%s#%s", n->filename,
	         query ? query : "", n->anchor);
      else
        snprintf(line, sizeof(line), "/help/%s?QUERY=%s", n->filename,
	         query ? query : "");

      cgiSetArray("QTEXT", i, n->text);
      cgiSetArray("QLINK", i, line);

      if (!helpfile && n->anchor)
      {
        nn = helpFindNode(hi, n->filename, NULL);

        snprintf(line, sizeof(line), "/help/%s?QUERY=%s", nn->filename,
	         query ? query : "");

        cgiSetArray("QPTEXT", i, nn->text);
	cgiSetArray("QPLINK", i, line);
      }
      else
      {
        cgiSetArray("QPTEXT", i, "");
	cgiSetArray("QPLINK", i, "");
      }

      fprintf(stderr, "DEBUG: [%d] = \"%s\" @ \"%s\"\n", i, n->text, line);
    }

    helpDeleteIndex(si);
  }

 /*
  * OK, now list the bookmarks within the index...
  */

  for (i = 0, section = NULL, n = (help_node_t *)cupsArrayFirst(hi->sorted);
       n;
       n = (help_node_t *)cupsArrayNext(hi->sorted))
  {
    if (n->anchor)
      continue;

   /*
    * Add a section link as needed...
    */

    if (n->section &&
        (!section || strcmp(n->section, section)))
    {
     /*
      * Add a link for this node...
      */

      snprintf(line, sizeof(line), "/help/?TOPIC=%s&QUERY=%s",
               cgiFormEncode(topic_data, n->section, sizeof(topic_data)),
	       query ? query : "");
      cgiSetArray("BMLINK", i, line);
      cgiSetArray("BMTEXT", i, n->section);
      cgiSetArray("BMINDENT", i, "0");

      i ++;
      section = n->section;
    }

    if (!topic || !n->section || strcmp(n->section, topic))
      continue;

   /*
    * Add a link for this node...
    */

    snprintf(line, sizeof(line), "/help/%s?TOPIC=%s&QUERY=%s", n->filename,
             cgiFormEncode(topic_data, n->section, sizeof(topic_data)),
	     query ? query : "");
    cgiSetArray("BMLINK", i, line);
    cgiSetArray("BMTEXT", i, n->text);
    cgiSetArray("BMINDENT", i, "1");

    i ++;

    if (helpfile && !strcmp(helpfile, n->filename))
    {
      help_node_t	*nn;		/* Pointer to sub-node */


      cupsArraySave(hi->sorted);

      for (nn = (help_node_t *)cupsArrayFirst(hi->sorted);
           nn;
	   nn = (help_node_t *)cupsArrayNext(hi->sorted))
        if (nn->anchor && !strcmp(helpfile, nn->filename))
	{
	 /*
	  * Add a link for this node...
	  */

	  snprintf(line, sizeof(line), "#%s", nn->anchor);
	  cgiSetArray("BMLINK", i, line);
	  cgiSetArray("BMTEXT", i, nn->text);
	  cgiSetArray("BMINDENT", i, "2");

	  i ++;
	}

      cupsArrayRestore(hi->sorted);
    }
  }

 /*
  * Show the search and bookmark content...
  */

  if (!helpfile || !printable)
    cgiCopyTemplateLang("help-header.tmpl");
  else
    cgiCopyTemplateLang("help-printable.tmpl");

 /*
  * If we are viewing a file, copy it in now...
  */

  if (helpfile)
  {
    if ((fp = cupsFileOpen(filename, "r")) != NULL)
    {
      int	inbody;			/* Are we inside the body? */


      inbody = 0;

      while (cupsFileGets(fp, line, sizeof(line)))
      {
        if (inbody)
	{
	  if (!_cups_strncasecmp(line, "</BODY>", 7))
	    break;

	  printf("%s\n", line);
        }
	else if (!_cups_strncasecmp(line, "<BODY", 5))
	  inbody = 1;
      }

      cupsFileClose(fp);
    }
    else
    {
      perror(filename);
      cgiSetVariable("ERROR", cgiText(_("Unable to open help file.")));
      cgiCopyTemplateLang("error.tmpl");
    }
  }

 /*
  * Send a standard trailer...
  */

  if (!printable)
  {
    cgiCopyTemplateLang("help-trailer.tmpl");
    cgiEndHTML();
  }
  else
    puts("</BODY>\n</HTML>");

 /*
  * Delete the index...
  */

  helpDeleteIndex(hi);

 /*
  * Return with no errors...
  */

  return (0);
}
Commit	Line	Data
ef416fc2	1	/*
503b54c9	2	* Online help CGI for CUPS.
ef416fc2	3	*
503b54c9 MS	4	* Copyright 2007-2011 by Apple Inc.
503b54c9 MS	5	* Copyright 1997-2006 by Easy Software Products.
ef416fc2	6	*
e3101897	7	* Licensed under Apache License v2.0. See the file "LICENSE" for more information.
ef416fc2	8	*/
	9
	10	/*
	11	* Include necessary headers...
	12	*/
	13
	14	#include "cgi-private.h"
	15
	16
	17	/*
	18	* 'main()' - Main entry for CGI.
	19	*/
	20
	21	int /* O - Exit status */
	22	main(int argc, /* I - Number of command-line arguments */
	23	char argv[]) / I - Command-line arguments */
	24	{
	25	help_index_t hi, / Help index */
	26	si; / Search index */
ecdc0628	27	help_node_t n; / Current help node */
ecdc0628	28	int i; /* Looping var */
ef416fc2	29	const char query; / Search query */
ecdc0628	30	const char cache_dir; / CUPS_CACHEDIR environment variable */
ef416fc2	31	const char docroot; / CUPS_DOCROOT environment variable */
82cc1f9a MS	32	const char helpfile, / Current help file */
82cc1f9a MS	33	helptitle = NULL; / Current help title */
ef416fc2	34	const char topic; / Current topic */
	35	char topic_data[1024]; /* Topic form data */
	36	const char section; / Current section */
	37	char filename[1024], /* Filename */
	38	directory[1024]; /* Directory */
	39	cups_file_t fp; / Help file */
	40	char line[1024]; /* Line from file */
4744bd90	41	int printable; /* Show printable version? */
ef416fc2	42
	43
	44	/*
	45	* Get any form variables...
	46	*/
	47
	48	cgiInitialize();
	49
4744bd90	50	printable = cgiGetVariable("PRINTABLE") != NULL;
4744bd90	51
ef416fc2	52	/*
	53	* Set the web interface section...
	54	*/
	55
	56	cgiSetVariable("SECTION", "help");
ef55b745	57	cgiSetVariable("REFRESH_PAGE", "");
ef416fc2	58
	59	/*
	60	* Load the help index...
	61	*/
	62
ecdc0628	63	if ((cache_dir = getenv("CUPS_CACHEDIR")) == NULL)
ecdc0628	64	cache_dir = CUPS_CACHEDIR;
ef416fc2	65
ecdc0628	66	snprintf(filename, sizeof(filename), "%s/help.index", cache_dir);
ef416fc2	67
	68	if ((docroot = getenv("CUPS_DOCROOT")) == NULL)
	69	docroot = CUPS_DOCROOT;
	70
	71	snprintf(directory, sizeof(directory), "%s/help", docroot);
	72
	73	fprintf(stderr, "DEBUG: helpLoadIndex(filename=\"%s\", directory=\"%s\")\n",
	74	filename, directory);
	75
	76	hi = helpLoadIndex(filename, directory);
	77	if (!hi)
	78	{
	79	perror(filename);
	80
2e4ff8af	81	cgiStartHTML(cgiText(_("Online Help")));
82cc1f9a	82	cgiSetVariable("ERROR", cgiText(_("Unable to load help index.")));
ef416fc2	83	cgiCopyTemplateLang("error.tmpl");
	84	cgiEndHTML();
	85
	86	return (1);
	87	}
	88
ecdc0628	89	fprintf(stderr, "DEBUG: %d nodes in help index...\n",
ecdc0628	90	cupsArrayCount(hi->nodes));
ef416fc2	91
	92	/*
	93	* See if we are viewing a file...
	94	*/
	95
	96	for (i = 0; i < argc; i ++)
ef55b745	97	fprintf(stderr, "DEBUG: argv[%d]=\"%s\"\n", i, argv[i]);
ef416fc2	98
ef416fc2	99	if ((helpfile = getenv("PATH_INFO")) != NULL)
b423cd4c	100	{
ef416fc2	101	helpfile ++;
b423cd4c	102
	103	if (!*helpfile)
	104	helpfile = NULL;
	105	}
ef416fc2	106
	107	if (helpfile)
	108	{
	109	/*
	110	* Verify that the help file exists and is part of the index...
	111	*/
	112
	113	snprintf(filename, sizeof(filename), "%s/help/%s", docroot, helpfile);
	114
	115	fprintf(stderr, "DEBUG: helpfile=\"%s\", filename=\"%s\"\n",
	116	helpfile, filename);
	117
	118	if (access(filename, R_OK))
	119	{
	120	perror(filename);
	121
2e4ff8af	122	cgiStartHTML(cgiText(_("Online Help")));
82cc1f9a	123	cgiSetVariable("ERROR", cgiText(_("Unable to access help file.")));
ef416fc2	124	cgiCopyTemplateLang("error.tmpl");
	125	cgiEndHTML();
	126
	127	return (1);
	128	}
	129
	130	if ((n = helpFindNode(hi, helpfile, NULL)) == NULL)
	131	{
2e4ff8af	132	cgiStartHTML(cgiText(_("Online Help")));
82cc1f9a	133	cgiSetVariable("ERROR", cgiText(_("Help file not in index.")));
ef416fc2	134	cgiCopyTemplateLang("error.tmpl");
	135	cgiEndHTML();
	136
	137	return (1);
	138	}
	139
	140	/*
82cc1f9a	141	* Save the page title and help file...
ef416fc2	142	*/
ef416fc2	143
82cc1f9a MS	144	helptitle = n->text;
82cc1f9a MS	145	topic = n->section;
ef416fc2	146
	147	/*
	148	* Send a standard page header...
	149	*/
	150
4744bd90	151	if (printable)
	152	puts("Content-Type: text/html;charset=utf-8\n");
	153	else
	154	cgiStartHTML(n->text);
ef416fc2	155	}
	156	else
	157	{
	158	/*
	159	* Send a standard page header...
	160	*/
	161
2e4ff8af	162	cgiStartHTML(cgiText(_("Online Help")));
82cc1f9a MS	163
82cc1f9a MS	164	topic = cgiGetVariable("TOPIC");
ef416fc2	165	}
	166
	167	/*
	168	* Do a search as needed...
	169	*/
	170
2e4ff8af MS	171	if (cgiGetVariable("CLEAR"))
	172	cgiSetVariable("QUERY", "");
	173
ef416fc2	174	query = cgiGetVariable("QUERY");
ef416fc2	175	si = helpSearchIndex(hi, query, topic, helpfile);
ef416fc2	176
ef55b745 MS	177	cgiClearVariables();
	178	if (query)
	179	cgiSetVariable("QUERY", query);
	180	if (topic)
	181	cgiSetVariable("TOPIC", topic);
82cc1f9a MS	182	if (helpfile)
	183	cgiSetVariable("HELPFILE", helpfile);
	184	if (helptitle)
	185	cgiSetVariable("HELPTITLE", helptitle);
ef55b745	186
f301802f	187	fprintf(stderr, "DEBUG: query=\"%s\", topic=\"%s\"\n",
f301802f	188	query ? query : "(null)", topic ? topic : "(null)");
b423cd4c	189
ef416fc2	190	if (si)
ef416fc2	191	{
ecdc0628	192	help_node_t nn; / Parent node */
ef416fc2	193
ef416fc2	194
ecdc0628	195	fprintf(stderr,
	196	"DEBUG: si=%p, si->sorted=%p, cupsArrayCount(si->sorted)=%d\n", si,
	197	si->sorted, cupsArrayCount(si->sorted));
ef416fc2	198
b423cd4c	199	for (i = 0, n = (help_node_t *)cupsArrayFirst(si->sorted);
ecdc0628	200	n;
b423cd4c	201	i ++, n = (help_node_t *)cupsArrayNext(si->sorted))
ef416fc2	202	{
ecdc0628	203	if (helpfile && n->anchor)
	204	snprintf(line, sizeof(line), "#%s", n->anchor);
	205	else if (n->anchor)
	206	snprintf(line, sizeof(line), "/help/%s?QUERY=%s#%s", n->filename,
	207	query ? query : "", n->anchor);
ef416fc2	208	else
ecdc0628	209	snprintf(line, sizeof(line), "/help/%s?QUERY=%s", n->filename,
ef416fc2	210	query ? query : "");
ef416fc2	211
ecdc0628	212	cgiSetArray("QTEXT", i, n->text);
ef416fc2	213	cgiSetArray("QLINK", i, line);
ef416fc2	214
ecdc0628	215	if (!helpfile && n->anchor)
ef416fc2	216	{
ecdc0628	217	nn = helpFindNode(hi, n->filename, NULL);
ef416fc2	218
ecdc0628	219	snprintf(line, sizeof(line), "/help/%s?QUERY=%s", nn->filename,
ef416fc2	220	query ? query : "");
ef416fc2	221
ecdc0628	222	cgiSetArray("QPTEXT", i, nn->text);
ef416fc2	223	cgiSetArray("QPLINK", i, line);
	224	}
	225	else
	226	{
	227	cgiSetArray("QPTEXT", i, "");
	228	cgiSetArray("QPLINK", i, "");
	229	}
	230
ecdc0628	231	fprintf(stderr, "DEBUG: [%d] = \"%s\" @ \"%s\"\n", i, n->text, line);
ef416fc2	232	}
	233
	234	helpDeleteIndex(si);
	235	}
	236
	237	/*
	238	* OK, now list the bookmarks within the index...
	239	*/
	240
ecdc0628	241	for (i = 0, section = NULL, n = (help_node_t *)cupsArrayFirst(hi->sorted);
	242	n;
	243	n = (help_node_t *)cupsArrayNext(hi->sorted))
ef416fc2	244	{
ecdc0628	245	if (n->anchor)
ef416fc2	246	continue;
	247
	248	/*
	249	* Add a section link as needed...
	250	*/
	251
ecdc0628	252	if (n->section &&
ecdc0628	253	(!section \|\| strcmp(n->section, section)))
ef416fc2	254	{
	255	/*
	256	* Add a link for this node...
	257	*/
	258
	259	snprintf(line, sizeof(line), "/help/?TOPIC=%s&QUERY=%s",
ecdc0628	260	cgiFormEncode(topic_data, n->section, sizeof(topic_data)),
ef416fc2	261	query ? query : "");
ecdc0628	262	cgiSetArray("BMLINK", i, line);
	263	cgiSetArray("BMTEXT", i, n->section);
	264	cgiSetArray("BMINDENT", i, "0");
ef416fc2	265
ecdc0628	266	i ++;
ecdc0628	267	section = n->section;
ef416fc2	268	}
ef416fc2	269
7f500d89	270	if (!topic \|\| !n->section \|\| strcmp(n->section, topic))
ef416fc2	271	continue;
	272
	273	/*
	274	* Add a link for this node...
	275	*/
	276
ecdc0628	277	snprintf(line, sizeof(line), "/help/%s?TOPIC=%s&QUERY=%s", n->filename,
ecdc0628	278	cgiFormEncode(topic_data, n->section, sizeof(topic_data)),
ef416fc2	279	query ? query : "");
ecdc0628	280	cgiSetArray("BMLINK", i, line);
	281	cgiSetArray("BMTEXT", i, n->text);
	282	cgiSetArray("BMINDENT", i, "1");
ef416fc2	283
ecdc0628	284	i ++;
ef416fc2	285
ecdc0628	286	if (helpfile && !strcmp(helpfile, n->filename))
ef416fc2	287	{
ecdc0628	288	help_node_t nn; / Pointer to sub-node */
ef416fc2	289
ef416fc2	290
ecdc0628	291	cupsArraySave(hi->sorted);
	292
	293	for (nn = (help_node_t *)cupsArrayFirst(hi->sorted);
	294	nn;
	295	nn = (help_node_t *)cupsArrayNext(hi->sorted))
	296	if (nn->anchor && !strcmp(helpfile, nn->filename))
ef416fc2	297	{
	298	/*
	299	* Add a link for this node...
	300	*/
	301
ecdc0628	302	snprintf(line, sizeof(line), "#%s", nn->anchor);
	303	cgiSetArray("BMLINK", i, line);
	304	cgiSetArray("BMTEXT", i, nn->text);
	305	cgiSetArray("BMINDENT", i, "2");
ef416fc2	306
ecdc0628	307	i ++;
ef416fc2	308	}
ecdc0628	309
ecdc0628	310	cupsArrayRestore(hi->sorted);
ef416fc2	311	}
	312	}
	313
	314	/*
	315	* Show the search and bookmark content...
	316	*/
	317
4744bd90	318	if (!helpfile \|\| !printable)
	319	cgiCopyTemplateLang("help-header.tmpl");
	320	else
	321	cgiCopyTemplateLang("help-printable.tmpl");
ef416fc2	322
	323	/*
	324	* If we are viewing a file, copy it in now...
	325	*/
	326
	327	if (helpfile)
	328	{
	329	if ((fp = cupsFileOpen(filename, "r")) != NULL)
	330	{
	331	int inbody; /* Are we inside the body? */
	332
	333
	334	inbody = 0;
	335
	336	while (cupsFileGets(fp, line, sizeof(line)))
	337	{
	338	if (inbody)
	339	{
88f9aafc	340	if (!_cups_strncasecmp(line, "</BODY>", 7))
ef416fc2	341	break;
	342
	343	printf("%s\n", line);
	344	}
88f9aafc	345	else if (!_cups_strncasecmp(line, "<BODY", 5))
ef416fc2	346	inbody = 1;
	347	}
	348
	349	cupsFileClose(fp);
	350	}
	351	else
	352	{
	353	perror(filename);
82cc1f9a	354	cgiSetVariable("ERROR", cgiText(_("Unable to open help file.")));
ef416fc2	355	cgiCopyTemplateLang("error.tmpl");
	356	}
	357	}
	358
	359	/*
	360	* Send a standard trailer...
	361	*/
	362
4744bd90	363	if (!printable)
b19ccc9e MS	364	{
b19ccc9e MS	365	cgiCopyTemplateLang("help-trailer.tmpl");
4744bd90	366	cgiEndHTML();
b19ccc9e	367	}
4744bd90	368	else
4744bd90	369	puts("</BODY>\n</HTML>");
ef416fc2	370
	371	/*
	372	* Delete the index...
	373	*/
	374
	375	helpDeleteIndex(hi);
	376
	377	/*
	378	* Return with no errors...
	379	*/
	380
	381	return (0);
	382	}