Automated function-comment nitpicking.
[privoxy.git] / miscutil.c
index ed09ff8..bb5677e 100644 (file)
@@ -1,10 +1,10 @@
-const char miscutil_rcs[] = "$Id: miscutil.c,v 1.25 2001/11/13 00:16:38 jongfoster Exp $";
+const char miscutil_rcs[] = "$Id: miscutil.c,v 1.30 2002/03/04 18:27:42 oes Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/miscutil.c,v $
  *
  * Purpose     :  zalloc, hash_string, safe_strerror, strcmpic,
- *                strncmpic, strsav, chomp, and MinGW32 strdup
+ *                strncmpic, chomp, and MinGW32 strdup
  *                functions. 
  *                These are each too small to deserve their own file
  *                but don't really fit in any other file.
@@ -36,6 +36,29 @@ const char miscutil_rcs[] = "$Id: miscutil.c,v 1.25 2001/11/13 00:16:38 jongfost
  *
  * Revisions   :
  *    $Log: miscutil.c,v $
+ *    Revision 1.30  2002/03/04 18:27:42  oes
+ *    - Deleted deletePidFile
+ *    - Made write_pid_file use the --pidfile option value
+ *      (or no PID file, if the option was absent)
+ *    - Played styleguide police
+ *
+ *    Revision 1.29  2002/03/04 02:08:02  david__schmidt
+ *    Enable web editing of actions file on OS/2 (it had been broken all this time!)
+ *
+ *    Revision 1.28  2002/03/03 09:18:03  joergs
+ *    Made jumbjuster work on AmigaOS again.
+ *
+ *    Revision 1.27  2002/01/21 00:52:32  jongfoster
+ *    Adding string_join()
+ *
+ *    Revision 1.26  2001/12/30 14:07:32  steudten
+ *    - Add signal handling (unix)
+ *    - Add SIGHUP handler (unix)
+ *    - Add creation of pidfile (unix)
+ *    - Add action 'top' in rc file (RH)
+ *    - Add entry 'SIGNALS' to manpage
+ *    - Add exit message to logfile (unix)
+ *
  *    Revision 1.25  2001/11/13 00:16:38  jongfoster
  *    Replacing references to malloc.h with the standard stdlib.h
  *    (See ANSI or K&R 2nd Ed)
@@ -174,6 +197,7 @@ const char miscutil_rcs[] = "$Id: miscutil.c,v 1.25 2001/11/13 00:16:38 jongfost
 #include "project.h"
 #include "miscutil.h"
 #include "errlog.h"
+#include "jcc.h"
 
 const char miscutil_h_rcs[] = MISCUTIL_H_VERSION;
 
@@ -200,53 +224,46 @@ void *zalloc(int size)
    }
 
    return(ret);
-}
-#if defined(unix)
-/*********************************************************************
- *
- * Function    : deletePidFile 
- *
- * Description :  deletes the pid file with the pid of the main process 
- *
- * Parameters  : -
- *
- * Returns     : - 
- *
- *********************************************************************/
-void deletePidFile( void )
-{
-  char pidfile[ 64 ];
 
-  snprintf( pidfile, sizeof(pidfile), "%s/%s", PID_FILE_PATH, PID_FILE_NAME);
-  unlink( pidfile );
 }
+
+
+#if defined(unix)
 /*********************************************************************
  *
- * Function    : writePidFile 
+ * Function    :  write_pid_file 
  *
- * Description :  writes the pid file with the pid of the main process 
+ * Description :  Writes a pid file with the pid of the main process 
  *
- * Parameters  : -
+ * Parameters  :  None
  *
- * Returns     : - 
+ * Returns     :  N/A 
  *
  *********************************************************************/
-void writePidFile( void )
+void write_pid_file(void)
 {
-  FILE   *fp;
-  char   pidfile[64];
+   FILE   *fp;
+   
+   /*
+    * If no --pidfile option was given,
+    * we can live without one.
+    */
+   if (pidfile == NULL) return;
 
-  snprintf( pidfile, sizeof(pidfile), "%s/%s", PID_FILE_PATH, PID_FILE_NAME);
-  if ((fp = fopen( pidfile,"w")) == NULL )
-  {
+   if ((fp = fopen(pidfile, "w")) == NULL)
+   {
       log_error(LOG_LEVEL_INFO, "can't open pidfile '%s': %E", pidfile);
-      return;
-  }
+   }
+   else
+   {
+      fprintf(fp, "%u\n", (unsigned int) getpid());
+      fclose (fp);
+   }
+   return;
 
-  fprintf( fp,"%u\n", (unsigned int) getpid());
-  fclose ( fp );
 }
-#endif /* unix */
+#endif /* def unix */
+
 
 /*********************************************************************
  *
@@ -518,8 +535,8 @@ char *strsav(char *old, const char *text_to_append)
  *
  * Description :  Reallocate target_string and append text to it.  
  *                This makes it easier to append to malloc'd strings.
- *                This is similar to strsav(), but running out of
- *                memory isn't catastrophic.
+ *                This is similar to the (removed) strsav(), but
+ *                running out of memory isn't catastrophic.
  *
  *                Programming style:
  *
@@ -596,6 +613,59 @@ jb_err string_append(char **target_string, const char *text_to_append)
 }
 
 
+/*********************************************************************
+ *
+ * Function    :  string_join
+ *
+ * Description :  Join two strings together.  Frees BOTH the original
+ *                strings.  If either or both input strings are NULL,
+ *                fails as if it had run out of memory.
+ *
+ *                For comparison, string_append requires that the
+ *                second string is non-NULL, and doesn't free it.
+ *
+ *                Rationale: Too often, we want to do
+ *                string_append(s, html_encode(s2)).  That assert()s
+ *                if s2 is NULL or if html_encode() runs out of memory.
+ *                It also leaks memory.  Proper checking is cumbersome.
+ *                The solution: string_join(s, html_encode(s2)) is safe,
+ *                and will free the memory allocated by html_encode().
+ *
+ * Parameters  :
+ *          1  :  target_string = Pointer to old text that is to be
+ *                extended.  *target_string will be free()d by this
+ *                routine.  target_string must be non-NULL.
+ *          2  :  text_to_append = Text to be appended to old.
+ *
+ * Returns     :  JB_ERR_OK on success, and sets *target_string
+ *                   to newly malloc'ed appended string.  Caller
+ *                   must free(*target_string).
+ *                JB_ERR_MEMORY on out-of-memory, or if
+ *                   *target_string or text_to_append is NULL.  (In
+ *                   this case, frees *target_string and text_to_append,
+ *                   sets *target_string to NULL).
+ *
+ *********************************************************************/
+jb_err string_join(char **target_string, char *text_to_append)
+{
+   jb_err err;
+
+   assert(target_string);
+
+   if (text_to_append == NULL)
+   {
+      freez(*target_string);
+      return JB_ERR_MEMORY;
+   }
+
+   err = string_append(target_string, text_to_append);
+
+   free(text_to_append);
+
+   return err;
+}
+
+
 /*********************************************************************
  *
  * Function    :  simplematch
@@ -771,7 +841,21 @@ char * make_path(const char * dir, const char * file)
 
    if(dir)
    {
-      strncpy(path,dir,512);
+      if(dir[0] == '.')
+      {
+         if(dir[1] == '/')
+         {
+            strncpy(path,dir+2,512);
+         }
+         else
+         {
+            strncpy(path,dir+1,512);
+         }
+      }
+      else
+      {
+         strncpy(path,dir,512);
+      }
       path[511]=0;
    } else {
       path[0]=0;
@@ -790,11 +874,11 @@ char * make_path(const char * dir, const char * file)
    }
 
    if ((dir == NULL) || (*dir == '\0') /* No directory specified */
-#ifdef _WIN32
+#if defined(_WIN32) || defined(__OS2__)
       || (*file == '\\') || (file[1] == ':') /* Absolute path (DOS) */
-#else /* ifndef _WIN32 */
+#else /* ifndef _WIN32 || __OS2__ */
       || (*file == '/') /* Absolute path (U*ix) */
-#endif /* ifndef _WIN32 */
+#endif /* ifndef _WIN32 || __OS2__  */
       )
    {
       return strdup(file);
@@ -811,7 +895,6 @@ char * make_path(const char * dir, const char * file)
              strcpy(path, basedir);
              strcat(path, "/");
              strcat(path, dir);
-             DBG(1, ("make_path: path: %s\n",path) );
       }
       else
       {
@@ -827,17 +910,17 @@ char * make_path(const char * dir, const char * file)
 
 #endif /* defined unix */
 
-#ifdef _WIN32
+#if defined(_WIN32) || defined(__OS2__)
       if(path[strlen(path)-1] != '\\')
       {
          strcat(path, "\\");
       }
-#else /* ifndef _WIN32 */
+#else /* ifndef _WIN32 || __OS2__ */
       if(path[strlen(path)-1] != '/')
       {
          strcat(path, "/");
       }
-#endif /* ifndef _WIN32 */
+#endif /* ifndef _WIN32 || __OS2__ */
       strcat(path, file);
 
       return path;