2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 % MagickCore Log Events %
20 % Copyright 1999-2013 ImageMagick Studio LLC, a non-profit organization %
21 % dedicated to making software imaging solutions freely available. %
23 % You may not use this file except in compliance with the License. You may %
24 % obtain a copy of the License at %
26 % http://www.imagemagick.org/script/license.php %
28 % Unless required by applicable law or agreed to in writing, software %
29 % distributed under the License is distributed on an "AS IS" BASIS, %
30 % WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
31 % See the License for the specific language governing permissions and %
32 % limitations under the License. %
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 #include "MagickCore/studio.h"
43 #include "MagickCore/blob.h"
44 #include "MagickCore/client.h"
45 #include "MagickCore/configure.h"
46 #include "MagickCore/configure-private.h"
47 #include "MagickCore/exception.h"
48 #include "MagickCore/exception-private.h"
49 #include "MagickCore/hashmap.h"
50 #include "MagickCore/log.h"
51 #include "MagickCore/log-private.h"
52 #include "MagickCore/memory_.h"
53 #include "MagickCore/option.h"
54 #include "MagickCore/semaphore.h"
55 #include "MagickCore/timer.h"
56 #include "MagickCore/string_.h"
57 #include "MagickCore/string-private.h"
58 #include "MagickCore/token.h"
59 #include "MagickCore/thread_.h"
60 #include "MagickCore/thread-private.h"
61 #include "MagickCore/utility.h"
62 #include "MagickCore/utility-private.h"
63 #include "MagickCore/version.h"
64 #include "MagickCore/xml-tree.h"
69 #define LogFilename "log.xml"
76 UndefinedHandler = 0x0000,
78 ConsoleHandler = 0x0001,
79 StdoutHandler = 0x0002,
80 StderrHandler = 0x0004,
82 DebugHandler = 0x0010,
86 typedef struct _EventInfo
95 typedef struct _HandlerInfo
140 typedef struct _LogMapInfo
156 static const HandlerInfo
159 { "Console", ConsoleHandler },
160 { "Debug", DebugHandler },
161 { "Event", EventHandler },
162 { "File", FileHandler },
163 { "None", NoHandler },
164 { "Stderr", StderrHandler },
165 { "Stdout", StdoutHandler },
166 { (char *) NULL, UndefinedHandler }
169 static const LogMapInfo
172 { NoEvents, ConsoleHandler, "Magick-%g.log",
173 "%t %r %u %v %d %c[%p]: %m/%f/%l/%d\\n %e" }
177 log_name[MaxTextExtent] = "Magick";
179 static LinkedListInfo
180 *log_list = (LinkedListInfo *) NULL;
183 *log_semaphore = (SemaphoreInfo *) NULL;
185 static volatile MagickBooleanType
186 instantiate_log = MagickFalse;
189 Forward declarations.
191 static LogHandlerType
192 ParseLogHandlers(const char *);
195 *GetLogInfo(const char *,ExceptionInfo *);
197 static MagickBooleanType
198 InitializeLogList(ExceptionInfo *),
199 LoadLogLists(const char *,ExceptionInfo *);
202 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
206 % C l o s e M a g i c k L o g %
210 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
212 % CloseMagickLog() closes the Magick log.
214 % The format of the CloseMagickLog method is:
216 % CloseMagickLog(void)
219 MagickExport void CloseMagickLog(void)
227 if (IsEventLogging() == MagickFalse)
229 exception=AcquireExceptionInfo();
230 log_info=GetLogInfo("*",exception);
231 exception=DestroyExceptionInfo(exception);
232 LockSemaphoreInfo(log_semaphore);
233 if (log_info->file != (FILE *) NULL)
235 (void) FormatLocaleFile(log_info->file,"</log>\n");
236 (void) fclose(log_info->file);
237 log_info->file=(FILE *) NULL;
239 UnlockSemaphoreInfo(log_semaphore);
243 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
247 + G e t L o g I n f o %
251 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
253 % GetLogInfo() searches the log list for the specified name and if found
254 % returns attributes for that log.
256 % The format of the GetLogInfo method is:
258 % LogInfo *GetLogInfo(const char *name,ExceptionInfo *exception)
260 % A description of each parameter follows:
262 % o name: the log name.
264 % o exception: return any errors or warnings in this structure.
267 static LogInfo *GetLogInfo(const char *name,ExceptionInfo *exception)
272 assert(exception != (ExceptionInfo *) NULL);
273 if ((log_list == (LinkedListInfo *) NULL) || (instantiate_log == MagickFalse))
274 if (InitializeLogList(exception) == MagickFalse)
275 return((LogInfo *) NULL);
276 if ((log_list == (LinkedListInfo *) NULL) ||
277 (IsLinkedListEmpty(log_list) != MagickFalse))
278 return((LogInfo *) NULL);
279 if ((name == (const char *) NULL) || (LocaleCompare(name,"*") == 0))
280 return((LogInfo *) GetValueFromLinkedList(log_list,0));
284 LockSemaphoreInfo(log_semaphore);
285 ResetLinkedListIterator(log_list);
286 p=(LogInfo *) GetNextValueInLinkedList(log_list);
287 while (p != (LogInfo *) NULL)
289 if (LocaleCompare(name,p->name) == 0)
291 p=(LogInfo *) GetNextValueInLinkedList(log_list);
293 if (p != (LogInfo *) NULL)
294 (void) InsertValueInLinkedList(log_list,0,
295 RemoveElementByValueFromLinkedList(log_list,p));
296 UnlockSemaphoreInfo(log_semaphore);
301 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
305 % G e t L o g I n f o L i s t %
309 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
311 % GetLogInfoList() returns any logs that match the specified pattern.
313 % The format of the GetLogInfoList function is:
315 % const LogInfo **GetLogInfoList(const char *pattern,
316 % size_t *number_preferences,ExceptionInfo *exception)
318 % A description of each parameter follows:
320 % o pattern: Specifies a pointer to a text string containing a pattern.
322 % o number_preferences: This integer returns the number of logs in the list.
324 % o exception: return any errors or warnings in this structure.
327 #if defined(__cplusplus) || defined(c_plusplus)
331 static int LogInfoCompare(const void *x,const void *y)
337 p=(const LogInfo **) x,
338 q=(const LogInfo **) y;
339 if (LocaleCompare((*p)->path,(*q)->path) == 0)
340 return(LocaleCompare((*p)->name,(*q)->name));
341 return(LocaleCompare((*p)->path,(*q)->path));
344 #if defined(__cplusplus) || defined(c_plusplus)
348 MagickExport const LogInfo **GetLogInfoList(const char *pattern,
349 size_t *number_preferences,ExceptionInfo *exception)
354 register const LogInfo
363 assert(pattern != (char *) NULL);
364 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",pattern);
365 assert(number_preferences != (size_t *) NULL);
366 *number_preferences=0;
367 p=GetLogInfo("*",exception);
368 if (p == (const LogInfo *) NULL)
369 return((const LogInfo **) NULL);
370 preferences=(const LogInfo **) AcquireQuantumMemory((size_t)
371 GetNumberOfElementsInLinkedList(log_list)+1UL,sizeof(*preferences));
372 if (preferences == (const LogInfo **) NULL)
373 return((const LogInfo **) NULL);
377 LockSemaphoreInfo(log_semaphore);
378 ResetLinkedListIterator(log_list);
379 p=(const LogInfo *) GetNextValueInLinkedList(log_list);
380 for (i=0; p != (const LogInfo *) NULL; )
382 if ((p->stealth == MagickFalse) &&
383 (GlobExpression(p->name,pattern,MagickFalse) != MagickFalse))
385 p=(const LogInfo *) GetNextValueInLinkedList(log_list);
387 UnlockSemaphoreInfo(log_semaphore);
388 qsort((void *) preferences,(size_t) i,sizeof(*preferences),LogInfoCompare);
389 preferences[i]=(LogInfo *) NULL;
390 *number_preferences=(size_t) i;
395 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
399 % G e t L o g L i s t %
403 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
405 % GetLogList() returns any logs that match the specified pattern.
407 % The format of the GetLogList function is:
409 % char **GetLogList(const char *pattern,size_t *number_preferences,
410 % ExceptionInfo *exception)
412 % A description of each parameter follows:
414 % o pattern: Specifies a pointer to a text string containing a pattern.
416 % o number_preferences: This integer returns the number of logs in the list.
418 % o exception: return any errors or warnings in this structure.
422 #if defined(__cplusplus) || defined(c_plusplus)
426 static int LogCompare(const void *x,const void *y)
434 return(LocaleCompare(*p,*q));
437 #if defined(__cplusplus) || defined(c_plusplus)
441 MagickExport char **GetLogList(const char *pattern,
442 size_t *number_preferences,ExceptionInfo *exception)
447 register const LogInfo
456 assert(pattern != (char *) NULL);
457 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",pattern);
458 assert(number_preferences != (size_t *) NULL);
459 *number_preferences=0;
460 p=GetLogInfo("*",exception);
461 if (p == (const LogInfo *) NULL)
462 return((char **) NULL);
463 preferences=(char **) AcquireQuantumMemory((size_t)
464 GetNumberOfElementsInLinkedList(log_list)+1UL,sizeof(*preferences));
465 if (preferences == (char **) NULL)
466 return((char **) NULL);
470 LockSemaphoreInfo(log_semaphore);
471 ResetLinkedListIterator(log_list);
472 p=(const LogInfo *) GetNextValueInLinkedList(log_list);
473 for (i=0; p != (const LogInfo *) NULL; )
475 if ((p->stealth == MagickFalse) &&
476 (GlobExpression(p->name,pattern,MagickFalse) != MagickFalse))
477 preferences[i++]=ConstantString(p->name);
478 p=(const LogInfo *) GetNextValueInLinkedList(log_list);
480 UnlockSemaphoreInfo(log_semaphore);
481 qsort((void *) preferences,(size_t) i,sizeof(*preferences),LogCompare);
482 preferences[i]=(char *) NULL;
483 *number_preferences=(size_t) i;
488 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
492 % G e t L o g N a m e %
496 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
498 % GetLogName() returns the current log name.
500 % The format of the GetLogName method is:
502 % const char *GetLogName(void)
505 MagickExport const char *GetLogName(void)
511 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
515 + I n i t i a l i z e L o g L i s t %
519 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
521 % InitializeLogList() initialize the log list.
523 % The format of the InitializeLogList method is:
525 % MagickBooleanType InitializeLogList(ExceptionInfo *exception)
527 % A description of each parameter follows.
529 % o exception: return any errors or warnings in this structure.
532 static MagickBooleanType InitializeLogList(ExceptionInfo *exception)
534 if ((log_list == (LinkedListInfo *) NULL) && (instantiate_log == MagickFalse))
536 if (log_semaphore == (SemaphoreInfo *) NULL)
537 AcquireSemaphoreInfo(&log_semaphore);
538 LockSemaphoreInfo(log_semaphore);
539 if ((log_list == (LinkedListInfo *) NULL) &&
540 (instantiate_log == MagickFalse))
542 (void) LoadLogLists(LogFilename,exception);
543 instantiate_log=MagickTrue;
545 UnlockSemaphoreInfo(log_semaphore);
547 return(log_list != (LinkedListInfo *) NULL ? MagickTrue : MagickFalse);
551 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
555 % I s E v e n t L o g g i n g %
559 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
561 % IsEventLogging() returns MagickTrue if debug of events is enabled otherwise
564 % The format of the IsEventLogging method is:
566 % MagickBooleanType IsEventLogging(void)
569 MagickExport MagickBooleanType IsEventLogging(void)
577 if ((log_list == (LinkedListInfo *) NULL) ||
578 (IsLinkedListEmpty(log_list) != MagickFalse))
580 exception=AcquireExceptionInfo();
581 log_info=GetLogInfo("*",exception);
582 exception=DestroyExceptionInfo(exception);
583 return(log_info->event_mask != NoEvents ? MagickTrue : MagickFalse);
586 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
590 % L i s t L o g I n f o %
594 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
596 % ListLogInfo() lists the log info to a file.
598 % The format of the ListLogInfo method is:
600 % MagickBooleanType ListLogInfo(FILE *file,ExceptionInfo *exception)
602 % A description of each parameter follows.
604 % o file: An pointer to a FILE.
606 % o exception: return any errors or warnings in this structure.
609 MagickExport MagickBooleanType ListLogInfo(FILE *file,ExceptionInfo *exception)
611 #define MegabytesToBytes(value) ((MagickSizeType) (value)*1024*1024)
628 if (file == (const FILE *) NULL)
630 log_info=GetLogInfoList("*",&number_aliases,exception);
631 if (log_info == (const LogInfo **) NULL)
634 path=(const char *) NULL;
635 for (i=0; i < (ssize_t) number_aliases; i++)
637 if (log_info[i]->stealth != MagickFalse)
639 if ((path == (const char *) NULL) ||
640 (LocaleCompare(path,log_info[i]->path) != 0))
645 if (log_info[i]->path != (char *) NULL)
646 (void) FormatLocaleFile(file,"\nPath: %s\n\n",log_info[i]->path);
648 for (j=0; j < (ssize_t) (8*sizeof(LogHandlerType)); j++)
654 if ((log_info[i]->handler_mask & mask) != 0)
656 (void) FormatLocaleFile(file,"%s ",LogHandlers[j].name);
657 length+=strlen(LogHandlers[j].name);
660 for (j=(ssize_t) length; j <= 12; j++)
661 (void) FormatLocaleFile(file," ");
662 (void) FormatLocaleFile(file," Generations Limit Format\n");
663 (void) FormatLocaleFile(file,"-----------------------------------------"
664 "--------------------------------------\n");
666 path=log_info[i]->path;
667 if (log_info[i]->filename != (char *) NULL)
669 (void) FormatLocaleFile(file,"%s",log_info[i]->filename);
670 for (j=(ssize_t) strlen(log_info[i]->filename); j <= 16; j++)
671 (void) FormatLocaleFile(file," ");
673 (void) FormatLocaleFile(file,"%9g ",(double) log_info[i]->generations);
674 (void) FormatLocaleFile(file,"%8g ",(double) log_info[i]->limit);
675 if (log_info[i]->format != (char *) NULL)
676 (void) FormatLocaleFile(file,"%s",log_info[i]->format);
677 (void) FormatLocaleFile(file,"\n");
680 log_info=(const LogInfo **) RelinquishMagickMemory((void *) log_info);
685 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
689 + L o g C o m p o n e n t G e n e s i s %
693 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
695 % LogComponentGenesis() instantiates the log component.
697 % The format of the LogComponentGenesis method is:
699 % MagickBooleanType LogComponentGenesis(void)
702 MagickPrivate MagickBooleanType LogComponentGenesis(void)
704 AcquireSemaphoreInfo(&log_semaphore);
709 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
713 + L o g C o m p o n e n t T e r m i n u s %
717 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
719 % LogComponentTerminus() destroys the logging component.
721 % The format of the LogComponentTerminus method is:
723 % LogComponentTerminus(void)
727 static void *DestroyLogElement(void *log_info)
732 p=(LogInfo *) log_info;
733 if (p->file != (FILE *) NULL)
735 (void) FormatLocaleFile(p->file,"</log>\n");
736 (void) fclose(p->file);
737 p->file=(FILE *) NULL;
739 if (p->exempt == MagickFalse)
741 if (p->format != (char *) NULL)
742 p->format=DestroyString(p->format);
743 if (p->path != (char *) NULL)
744 p->path=DestroyString(p->path);
745 if (p->filename != (char *) NULL)
746 p->filename=DestroyString(p->filename);
748 p=(LogInfo *) RelinquishMagickMemory(p);
749 return((void *) NULL);
752 MagickPrivate void LogComponentTerminus(void)
754 if (log_semaphore == (SemaphoreInfo *) NULL)
755 AcquireSemaphoreInfo(&log_semaphore);
756 LockSemaphoreInfo(log_semaphore);
757 if (log_list != (LinkedListInfo *) NULL)
758 log_list=DestroyLinkedList(log_list,DestroyLogElement);
759 instantiate_log=MagickFalse;
760 UnlockSemaphoreInfo(log_semaphore);
761 DestroySemaphoreInfo(&log_semaphore);
765 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
769 % L o g M a g i c k E v e n t %
773 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
775 % LogMagickEvent() logs an event as determined by the log configuration file.
776 % If an error occurs, MagickFalse is returned otherwise MagickTrue.
778 % The format of the LogMagickEvent method is:
780 % MagickBooleanType LogMagickEvent(const LogEventType type,
781 % const char *module,const char *function,const size_t line,
782 % const char *format,...)
784 % A description of each parameter follows:
786 % o type: the event type.
788 % o filename: the source module filename.
790 % o function: the function name.
792 % o line: the line number of the source module.
794 % o format: the output format.
797 static char *TranslateEvent(const LogEventType magick_unused(type),
798 const char *module,const char *function,const size_t line,
799 const char *domain,const char *event)
826 exception=AcquireExceptionInfo();
827 log_info=(LogInfo *) GetLogInfo("*",exception);
828 exception=DestroyExceptionInfo(exception);
829 seconds=time((time_t *) NULL);
830 elapsed_time=GetElapsedTime(&log_info->timer);
831 user_time=GetUserTime(&log_info->timer);
832 text=AcquireString(event);
833 if (log_info->format == (char *) NULL)
835 extent=strlen(event)+MaxTextExtent;
836 if (LocaleCompare(log_info->format,"xml") == 0)
839 timestamp[MaxTextExtent];
842 Translate event in "XML" format.
844 (void) FormatMagickTime(seconds,extent,timestamp);
845 (void) FormatLocaleString(text,extent,
847 " <timestamp>%s</timestamp>\n"
848 " <elapsed-time>%lu:%02lu.%03lu</elapsed-time>\n"
849 " <user-time>%0.3f</user-time>\n"
850 " <process-id>%.20g</process-id>\n"
851 " <thread-id>%.20g</thread-id>\n"
852 " <module>%s</module>\n"
853 " <function>%s</function>\n"
854 " <line>%.20g</line>\n"
855 " <domain>%s</domain>\n"
856 " <event>%s</event>\n"
857 "</entry>",timestamp,(unsigned long) (elapsed_time/60.0),
858 (unsigned long) floor(fmod(elapsed_time,60.0)),(unsigned long)
859 (1000.0*(elapsed_time-floor(elapsed_time))+0.5),user_time,
860 (double) getpid(),(double) GetMagickThreadSignature(),module,function,
861 (double) line,domain,event);
865 Translate event in "human readable" format.
868 for (p=log_info->format; *p != '\0'; p++)
871 if ((size_t) (q-text+MaxTextExtent) >= extent)
873 extent+=MaxTextExtent;
874 text=(char *) ResizeQuantumMemory(text,extent+MaxTextExtent,
876 if (text == (char *) NULL)
877 return((char *) NULL);
881 The format of the log is defined by embedding special format characters:
900 if ((*p == '\\') && (*(p+1) == 'r'))
906 if ((*p == '\\') && (*(p+1) == 'n'))
922 q+=CopyMagickString(q,GetClientName(),extent);
927 q+=CopyMagickString(q,domain,extent);
932 q+=CopyMagickString(q,event,extent);
937 q+=CopyMagickString(q,function,extent);
942 if (log_info->generations == 0)
944 (void) CopyMagickString(q,"0",extent);
948 q+=FormatLocaleString(q,extent,"%.20g",(double) (log_info->generation %
949 log_info->generations));
954 q+=FormatLocaleString(q,extent,"%.20g",(double) line);
962 for (p=module+strlen(module)-1; p > module; p--)
963 if (*p == *DirectorySeparator)
968 q+=CopyMagickString(q,p,extent);
973 q+=CopyMagickString(q,GetLogName(),extent);
978 q+=FormatLocaleString(q,extent,"%.20g",(double) getpid());
983 q+=FormatLocaleString(q,extent,"%lu:%02lu.%03lu",(unsigned long)
984 (elapsed_time/60.0),(unsigned long) floor(fmod(elapsed_time,60.0)),
985 (unsigned long) (1000.0*(elapsed_time-floor(elapsed_time))+0.5));
990 q+=FormatMagickTime(seconds,extent,q);
995 q+=FormatLocaleString(q,extent,"%0.3fu",user_time);
1000 q+=CopyMagickString(q,MagickLibVersionText,extent);
1020 static char *TranslateFilename(const LogInfo *log_info)
1035 Translate event in "human readable" format.
1037 assert(log_info != (LogInfo *) NULL);
1038 assert(log_info->filename != (char *) NULL);
1039 filename=AcquireString((char *) NULL);
1040 extent=MaxTextExtent;
1042 for (p=log_info->filename; *p != '\0'; p++)
1045 if ((size_t) (q-filename+MaxTextExtent) >= extent)
1047 extent+=MaxTextExtent;
1048 filename=(char *) ResizeQuantumMemory(filename,extent+MaxTextExtent,
1050 if (filename == (char *) NULL)
1051 return((char *) NULL);
1052 q=filename+strlen(filename);
1055 The format of the filename is defined by embedding special format
1074 q+=CopyMagickString(q,GetClientName(),extent);
1079 if (log_info->generations == 0)
1081 (void) CopyMagickString(q,"0",extent);
1085 q+=FormatLocaleString(q,extent,"%.20g",(double) (log_info->generation %
1086 log_info->generations));
1091 q+=CopyMagickString(q,GetLogName(),extent);
1096 q+=FormatLocaleString(q,extent,"%.20g",(double) getpid());
1101 q+=CopyMagickString(q,MagickLibVersionText,extent);
1121 MagickBooleanType LogMagickEventList(const LogEventType type,const char *module,
1122 const char *function,const size_t line,const char *format,
1126 event[MaxTextExtent],
1141 if (IsEventLogging() == MagickFalse)
1142 return(MagickFalse);
1143 exception=AcquireExceptionInfo();
1144 log_info=(LogInfo *) GetLogInfo("*",exception);
1145 exception=DestroyExceptionInfo(exception);
1146 LockSemaphoreInfo(log_semaphore);
1147 if ((log_info->event_mask & type) == 0)
1149 UnlockSemaphoreInfo(log_semaphore);
1152 domain=CommandOptionToMnemonic(MagickLogEventOptions,type);
1153 #if defined(MAGICKCORE_HAVE_VSNPRINTF)
1154 n=vsnprintf(event,MaxTextExtent,format,operands);
1156 n=vsprintf(event,format,operands);
1159 event[MaxTextExtent-1]='\0';
1160 text=TranslateEvent(type,module,function,line,domain,event);
1161 if (text == (char *) NULL)
1163 (void) ContinueTimer((TimerInfo *) &log_info->timer);
1164 UnlockSemaphoreInfo(log_semaphore);
1165 return(MagickFalse);
1167 if ((log_info->handler_mask & ConsoleHandler) != 0)
1169 (void) FormatLocaleFile(stderr,"%s\n",text);
1170 (void) fflush(stderr);
1172 if ((log_info->handler_mask & DebugHandler) != 0)
1174 #if defined(MAGICKCORE_WINDOWS_SUPPORT)
1175 OutputDebugString(text);
1178 if ((log_info->handler_mask & EventHandler) != 0)
1180 #if defined(MAGICKCORE_WINDOWS_SUPPORT)
1181 (void) NTReportEvent(text,MagickFalse);
1184 if ((log_info->handler_mask & FileHandler) != 0)
1189 file_info.st_size=0;
1190 if (log_info->file != (FILE *) NULL)
1191 (void) fstat(fileno(log_info->file),&file_info);
1192 if (file_info.st_size > (ssize_t) (1024*1024*log_info->limit))
1194 (void) FormatLocaleFile(log_info->file,"</log>\n");
1195 (void) fclose(log_info->file);
1196 log_info->file=(FILE *) NULL;
1198 if (log_info->file == (FILE *) NULL)
1203 filename=TranslateFilename(log_info);
1204 if (filename == (char *) NULL)
1206 (void) ContinueTimer((TimerInfo *) &log_info->timer);
1207 UnlockSemaphoreInfo(log_semaphore);
1208 return(MagickFalse);
1210 log_info->append=IsPathAccessible(filename);
1211 log_info->file=fopen_utf8(filename,"ab");
1212 filename=(char *) RelinquishMagickMemory(filename);
1213 if (log_info->file == (FILE *) NULL)
1215 UnlockSemaphoreInfo(log_semaphore);
1216 return(MagickFalse);
1218 log_info->generation++;
1219 if (log_info->append == MagickFalse)
1220 (void) FormatLocaleFile(log_info->file,"<?xml version=\"1.0\" "
1221 "encoding=\"UTF-8\" standalone=\"yes\"?>\n");
1222 (void) FormatLocaleFile(log_info->file,"<log>\n");
1224 (void) FormatLocaleFile(log_info->file," <event>%s</event>\n",text);
1225 (void) fflush(log_info->file);
1227 if ((log_info->handler_mask & StdoutHandler) != 0)
1229 (void) FormatLocaleFile(stdout,"%s\n",text);
1230 (void) fflush(stdout);
1232 if ((log_info->handler_mask & StderrHandler) != 0)
1234 (void) FormatLocaleFile(stderr,"%s\n",text);
1235 (void) fflush(stderr);
1237 text=(char *) RelinquishMagickMemory(text);
1238 (void) ContinueTimer((TimerInfo *) &log_info->timer);
1239 UnlockSemaphoreInfo(log_semaphore);
1243 MagickBooleanType LogMagickEvent(const LogEventType type,const char *module,
1244 const char *function,const size_t line,const char *format,...)
1252 va_start(operands,format);
1253 status=LogMagickEventList(type,module,function,line,format,operands);
1259 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1263 + L o a d L o g L i s t %
1267 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1269 % LoadLogList() loads the log configuration file which provides a
1270 % mapping between log attributes and log name.
1272 % The format of the LoadLogList method is:
1274 % MagickBooleanType LoadLogList(const char *xml,const char *filename,
1275 % const size_t depth,ExceptionInfo *exception)
1277 % A description of each parameter follows:
1279 % o xml: The log list in XML format.
1281 % o filename: The log list filename.
1283 % o depth: depth of <include /> statements.
1285 % o exception: return any errors or warnings in this structure.
1288 static MagickBooleanType LoadLogList(const char *xml,const char *filename,
1289 const size_t depth,ExceptionInfo *exception)
1292 keyword[MaxTextExtent],
1299 *log_info = (LogInfo *) NULL;
1305 Load the log map file.
1307 if (xml == (const char *) NULL)
1308 return(MagickFalse);
1309 if (log_list == (LinkedListInfo *) NULL)
1311 log_list=NewLinkedList(0);
1312 if (log_list == (LinkedListInfo *) NULL)
1314 ThrowFileException(exception,ResourceLimitError,
1315 "MemoryAllocationFailed",filename);
1316 return(MagickFalse);
1320 token=AcquireString((const char *) xml);
1321 for (q=(const char *) xml; *q != '\0'; )
1326 GetMagickToken(q,&q,token);
1329 (void) CopyMagickString(keyword,token,MaxTextExtent);
1330 if (LocaleNCompare(keyword,"<!DOCTYPE",9) == 0)
1335 while ((LocaleNCompare(q,"]>",2) != 0) && (*q != '\0'))
1336 GetMagickToken(q,&q,token);
1339 if (LocaleNCompare(keyword,"<!--",4) == 0)
1344 while ((LocaleNCompare(q,"->",2) != 0) && (*q != '\0'))
1345 GetMagickToken(q,&q,token);
1348 if (LocaleCompare(keyword,"<include") == 0)
1353 while (((*token != '/') && (*(token+1) != '>')) && (*q != '\0'))
1355 (void) CopyMagickString(keyword,token,MaxTextExtent);
1356 GetMagickToken(q,&q,token);
1359 GetMagickToken(q,&q,token);
1360 if (LocaleCompare(keyword,"file") == 0)
1363 (void) ThrowMagickException(exception,GetMagickModule(),
1364 ConfigureError,"IncludeElementNestedTooDeeply","`%s'",token);
1368 path[MaxTextExtent],
1371 GetPathComponent(filename,HeadPath,path);
1373 (void) ConcatenateMagickString(path,DirectorySeparator,
1375 if (*token == *DirectorySeparator)
1376 (void) CopyMagickString(path,token,MaxTextExtent);
1378 (void) ConcatenateMagickString(path,token,MaxTextExtent);
1379 xml=FileToString(path,~0,exception);
1380 if (xml != (char *) NULL)
1382 status|=LoadLogList(xml,path,depth+1,exception);
1383 xml=DestroyString(xml);
1390 if (LocaleCompare(keyword,"<logmap>") == 0)
1393 Allocate memory for the log list.
1395 log_info=(LogInfo *) AcquireMagickMemory(sizeof(*log_info));
1396 if (log_info == (LogInfo *) NULL)
1397 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1398 (void) ResetMagickMemory(log_info,0,sizeof(*log_info));
1399 log_info->path=ConstantString(filename);
1400 GetTimerInfo((TimerInfo *) &log_info->timer);
1401 log_info->exempt=MagickFalse;
1402 log_info->signature=MagickSignature;
1405 if (log_info == (LogInfo *) NULL)
1407 if (LocaleCompare(keyword,"</logmap>") == 0)
1409 status=AppendValueToLinkedList(log_list,log_info);
1410 if (status == MagickFalse)
1411 (void) ThrowMagickException(exception,GetMagickModule(),
1412 ResourceLimitError,"MemoryAllocationFailed","`%s'",filename);
1413 log_info=(LogInfo *) NULL;
1415 GetMagickToken(q,(const char **) NULL,token);
1418 GetMagickToken(q,&q,token);
1419 GetMagickToken(q,&q,token);
1425 if (LocaleCompare((char *) keyword,"events") == 0)
1427 log_info->event_mask=(LogEventType) (log_info->event_mask |
1428 ParseCommandOption(MagickLogEventOptions,MagickTrue,token));
1436 if (LocaleCompare((char *) keyword,"filename") == 0)
1438 if (log_info->filename != (char *) NULL)
1439 log_info->filename=(char *)
1440 RelinquishMagickMemory(log_info->filename);
1441 log_info->filename=ConstantString(token);
1444 if (LocaleCompare((char *) keyword,"format") == 0)
1446 if (log_info->format != (char *) NULL)
1447 log_info->format=(char *)
1448 RelinquishMagickMemory(log_info->format);
1449 log_info->format=ConstantString(token);
1457 if (LocaleCompare((char *) keyword,"generations") == 0)
1459 if (LocaleCompare(token,"unlimited") == 0)
1461 log_info->generations=(~0UL);
1464 log_info->generations=StringToUnsignedLong(token);
1472 if (LocaleCompare((char *) keyword,"limit") == 0)
1474 if (LocaleCompare(token,"unlimited") == 0)
1476 log_info->limit=(~0UL);
1479 log_info->limit=StringToUnsignedLong(token);
1487 if (LocaleCompare((char *) keyword,"output") == 0)
1489 log_info->handler_mask=(LogHandlerType)
1490 (log_info->handler_mask | ParseLogHandlers(token));
1499 token=DestroyString(token);
1500 if (log_list == (LinkedListInfo *) NULL)
1501 return(MagickFalse);
1502 return(status != 0 ? MagickTrue : MagickFalse);
1506 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1510 % L o a d L o g L i s t s %
1514 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1516 % LoadLogLists() loads one or more log configuration file which provides a
1517 % mapping between log attributes and log name.
1519 % The format of the LoadLogLists method is:
1521 % MagickBooleanType LoadLogLists(const char *filename,
1522 % ExceptionInfo *exception)
1524 % A description of each parameter follows:
1526 % o filename: the log configuration filename.
1528 % o exception: return any errors or warnings in this structure.
1531 static MagickBooleanType LoadLogLists(const char *filename,
1532 ExceptionInfo *exception)
1547 Load external log map.
1549 if (log_list == (LinkedListInfo *) NULL)
1551 log_list=NewLinkedList(0);
1552 if (log_list == (LinkedListInfo *) NULL)
1554 ThrowFileException(exception,ResourceLimitError,
1555 "MemoryAllocationFailed",filename);
1556 return(MagickFalse);
1560 options=GetConfigureOptions(filename,exception);
1561 option=(const StringInfo *) GetNextValueInLinkedList(options);
1562 while (option != (const StringInfo *) NULL)
1564 status|=LoadLogList((const char *) GetStringInfoDatum(option),
1565 GetStringInfoPath(option),0,exception);
1566 option=(const StringInfo *) GetNextValueInLinkedList(options);
1568 options=DestroyConfigureOptions(options);
1570 Load built-in log map.
1572 for (i=0; i < (ssize_t) (sizeof(LogMap)/sizeof(*LogMap)); i++)
1577 register const LogMapInfo
1581 log_info=(LogInfo *) AcquireMagickMemory(sizeof(*log_info));
1582 if (log_info == (LogInfo *) NULL)
1584 (void) ThrowMagickException(exception,GetMagickModule(),
1585 ResourceLimitError,"MemoryAllocationFailed","`%s'",log_info->name);
1588 (void) ResetMagickMemory(log_info,0,sizeof(*log_info));
1589 log_info->path=(char *) "[built-in]";
1590 GetTimerInfo((TimerInfo *) &log_info->timer);
1591 log_info->event_mask=p->event_mask;
1592 log_info->handler_mask=p->handler_mask;
1593 log_info->filename=ConstantString(p->filename);
1594 log_info->format=ConstantString(p->format);
1595 log_info->exempt=MagickTrue;
1596 log_info->signature=MagickSignature;
1597 status|=AppendValueToLinkedList(log_list,log_info);
1598 if (status == MagickFalse)
1599 (void) ThrowMagickException(exception,GetMagickModule(),
1600 ResourceLimitError,"MemoryAllocationFailed","`%s'",log_info->name);
1602 return(status != 0 ? MagickTrue : MagickFalse);
1606 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1610 + P a r s e L o g H a n d l e r s %
1614 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1616 % ParseLogHandlers() parses a string defining which handlers takes a log
1617 % message and exports them.
1619 % The format of the ParseLogHandlers method is:
1621 % LogHandlerType ParseLogHandlers(const char *handlers)
1623 % A description of each parameter follows:
1625 % o handlers: one or more handlers separated by commas.
1628 static LogHandlerType ParseLogHandlers(const char *handlers)
1642 handler_mask=NoHandler;
1643 for (p=handlers; p != (char *) NULL; p=strchr(p,','))
1645 while ((*p != '\0') && ((isspace((int) ((unsigned char) *p)) != 0) ||
1648 for (i=0; LogHandlers[i].name != (char *) NULL; i++)
1650 length=strlen(LogHandlers[i].name);
1651 if (LocaleNCompare(p,LogHandlers[i].name,length) == 0)
1653 handler_mask=(LogHandlerType) (handler_mask | LogHandlers[i].handler);
1657 if (LogHandlers[i].name == (char *) NULL)
1658 return(UndefinedHandler);
1660 return(handler_mask);
1664 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1668 % S e t L o g E v e n t M a s k %
1672 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1674 % SetLogEventMask() accepts a list that determines which events to log. All
1675 % other events are ignored. By default, no debug is enabled. This method
1676 % returns the previous log event mask.
1678 % The format of the SetLogEventMask method is:
1680 % LogEventType SetLogEventMask(const char *events)
1682 % A description of each parameter follows:
1684 % o events: log these events.
1687 MagickExport LogEventType SetLogEventMask(const char *events)
1698 exception=AcquireExceptionInfo();
1699 log_info=(LogInfo *) GetLogInfo("*",exception);
1700 exception=DestroyExceptionInfo(exception);
1701 option=ParseCommandOption(MagickLogEventOptions,MagickTrue,events);
1702 LockSemaphoreInfo(log_semaphore);
1703 log_info=(LogInfo *) GetValueFromLinkedList(log_list,0);
1704 log_info->event_mask=(LogEventType) option;
1706 log_info->event_mask=UndefinedEvents;
1707 UnlockSemaphoreInfo(log_semaphore);
1708 return(log_info->event_mask);
1712 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1716 % S e t L o g F o r m a t %
1720 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1722 % SetLogFormat() sets the format for the "human readable" log record.
1724 % The format of the LogMagickFormat method is:
1726 % SetLogFormat(const char *format)
1728 % A description of each parameter follows:
1730 % o format: the log record format.
1733 MagickExport void SetLogFormat(const char *format)
1741 exception=AcquireExceptionInfo();
1742 log_info=(LogInfo *) GetLogInfo("*",exception);
1743 exception=DestroyExceptionInfo(exception);
1744 LockSemaphoreInfo(log_semaphore);
1745 if (log_info->format != (char *) NULL)
1746 log_info->format=DestroyString(log_info->format);
1747 log_info->format=ConstantString(format);
1748 UnlockSemaphoreInfo(log_semaphore);
1752 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1756 % S e t L o g N a m e %
1760 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1762 % SetLogName() sets the log name and returns it.
1764 % The format of the SetLogName method is:
1766 % const char *SetLogName(const char *name)
1768 % A description of each parameter follows:
1770 % o log_name: SetLogName() returns the current client name.
1772 % o name: Specifies the new client name.
1775 MagickExport const char *SetLogName(const char *name)
1777 if ((name != (char *) NULL) && (*name != '\0'))
1778 (void) CopyMagickString(log_name,name,MaxTextExtent);