/* %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % % % % % L OOO GGGG % % L O O G % % L O O G GG % % L O O G G % % LLLLL OOO GGG % % % % % % MagickCore Log Events % % % % Software Design % % Cristy % % September 2002 % % % % % % Copyright 1999-2021 ImageMagick Studio LLC, a non-profit organization % % dedicated to making software imaging solutions freely available. % % % % You may not use this file except in compliance with the License. You may % % obtain a copy of the License at % % % % https://imagemagick.org/script/license.php % % % % Unless required by applicable law or agreed to in writing, software % % distributed under the License is distributed on an "AS IS" BASIS, % % WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. % % See the License for the specific language governing permissions and % % limitations under the License. % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % */ /* Include declarations. */ #include "MagickCore/studio.h" #include "MagickCore/blob.h" #include "MagickCore/client.h" #include "MagickCore/configure.h" #include "MagickCore/configure-private.h" #include "MagickCore/exception.h" #include "MagickCore/exception-private.h" #include "MagickCore/linked-list.h" #include "MagickCore/log.h" #include "MagickCore/log-private.h" #include "MagickCore/memory_.h" #include "MagickCore/nt-base-private.h" #include "MagickCore/option.h" #include "MagickCore/semaphore.h" #include "MagickCore/timer.h" #include "MagickCore/string_.h" #include "MagickCore/string-private.h" #include "MagickCore/thread_.h" #include "MagickCore/thread-private.h" #include "MagickCore/timer-private.h" #include "MagickCore/token.h" #include "MagickCore/utility.h" #include "MagickCore/utility-private.h" #include "MagickCore/version.h" #include "MagickCore/xml-tree.h" #include "MagickCore/xml-tree-private.h" /* Define declarations. */ #define LogFilename "log.xml" /* Typedef declarations. */ typedef enum { UndefinedHandler = 0x0000, NoHandler = 0x0000, ConsoleHandler = 0x0001, StdoutHandler = 0x0002, StderrHandler = 0x0004, FileHandler = 0x0008, DebugHandler = 0x0010, EventHandler = 0x0020, MethodHandler = 0x0040 } LogHandlerType; typedef struct _EventInfo { char *name; LogEventType event; } EventInfo; typedef struct _HandlerInfo { const char name[10]; LogHandlerType handler; } HandlerInfo; struct _LogInfo { LogEventType event_mask; LogHandlerType handler_mask; char *path, *name, *filename, *format; size_t generations, limit; FILE *file; size_t generation; MagickBooleanType append, stealth; TimerInfo timer; MagickLogMethod method; SemaphoreInfo *event_semaphore; size_t signature; }; typedef struct _LogMapInfo { const LogEventType event_mask; const LogHandlerType handler_mask; const char *filename, *format; } LogMapInfo; /* Static declarations. */ static const HandlerInfo LogHandlers[32] = { { "Console", ConsoleHandler }, { "Debug", DebugHandler }, { "Event", EventHandler }, { "File", FileHandler }, { "None", NoHandler }, { "Stderr", StderrHandler }, { "Stdout", StdoutHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler }, { "", UndefinedHandler } }; static const LogMapInfo LogMap[] = { { NoEvents, ConsoleHandler, "Magick-%g.log", "%t %r %u %v %d %c[%p]: %m/%f/%l/%d\\n %e" } }; static char log_name[MagickPathExtent] = "Magick"; static LinkedListInfo *log_cache = (LinkedListInfo *) NULL; static MagickBooleanType event_logging = MagickFalse; static SemaphoreInfo *log_semaphore = (SemaphoreInfo *) NULL; /* Forward declarations. */ #if !MAGICKCORE_ZERO_CONFIGURATION_SUPPORT static LogHandlerType ParseLogHandlers(const char *) magick_attribute((__pure__)); #endif static LogInfo *GetLogInfo(const char *,ExceptionInfo *); static MagickBooleanType IsLogCacheInstantiated(ExceptionInfo *) magick_attribute((__pure__)); #if !MAGICKCORE_ZERO_CONFIGURATION_SUPPORT static MagickBooleanType LoadLogCache(LinkedListInfo *,const char *,const char *,const size_t, ExceptionInfo *); #endif /* %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % % % % % A c q u i r e L o g C a c h e % % % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % AcquireLogCache() caches one or more log configurations which provides a % mapping between log attributes and log name. % % The format of the AcquireLogCache method is: % % LinkedListInfo *AcquireLogCache(const char *filename, % ExceptionInfo *exception) % % A description of each parameter follows: % % o filename: the log configuration filename. % % o exception: return any errors or warnings in this structure. % */ static LinkedListInfo *AcquireLogCache(const char *filename, ExceptionInfo *exception) { LinkedListInfo *cache; MagickStatusType status; ssize_t i; /* Load external log map. */ cache=NewLinkedList(0); status=MagickTrue; #if !MAGICKCORE_ZERO_CONFIGURATION_SUPPORT { const StringInfo *option; LinkedListInfo *options; options=GetConfigureOptions(filename,exception); option=(const StringInfo *) GetNextValueInLinkedList(options); while (option != (const StringInfo *) NULL) { status&=LoadLogCache(cache,(const char *) GetStringInfoDatum(option), GetStringInfoPath(option),0,exception); option=(const StringInfo *) GetNextValueInLinkedList(options); } options=DestroyConfigureOptions(options); } #endif /* Load built-in log map. */ for (i=0; i < (ssize_t) (sizeof(LogMap)/sizeof(*LogMap)); i++) { LogInfo *log_info; const LogMapInfo *p; p=LogMap+i; log_info=(LogInfo *) AcquireMagickMemory(sizeof(*log_info)); if (log_info == (LogInfo *) NULL) { (void) ThrowMagickException(exception,GetMagickModule(), ResourceLimitError,"MemoryAllocationFailed","`%s'",p->filename); continue; } (void) memset(log_info,0,sizeof(*log_info)); log_info->path=ConstantString("[built-in]"); GetTimerInfo((TimerInfo *) &log_info->timer); log_info->event_mask=p->event_mask; log_info->handler_mask=p->handler_mask; log_info->filename=ConstantString(p->filename); log_info->format=ConstantString(p->format); log_info->signature=MagickCoreSignature; status&=AppendValueToLinkedList(cache,log_info); if (status == MagickFalse) (void) ThrowMagickException(exception,GetMagickModule(), ResourceLimitError,"MemoryAllocationFailed","`%s'",log_info->name); } return(cache); } /* %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % % % % % C l o s e M a g i c k L o g % % % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % CloseMagickLog() closes the Magick log. % % The format of the CloseMagickLog method is: % % CloseMagickLog(void) % */ MagickExport void CloseMagickLog(void) { ExceptionInfo *exception; LogInfo *log_info; if (IsEventLogging() == MagickFalse) return; exception=AcquireExceptionInfo(); log_info=GetLogInfo("*",exception); exception=DestroyExceptionInfo(exception); LockSemaphoreInfo(log_semaphore); if (log_info->file != (FILE *) NULL) { (void) FormatLocaleFile(log_info->file,"\n"); (void) fclose(log_info->file); log_info->file=(FILE *) NULL; } UnlockSemaphoreInfo(log_semaphore); } /* %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % % % % + G e t L o g I n f o % % % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % GetLogInfo() searches the log list for the specified name and if found % returns attributes for that log. % % The format of the GetLogInfo method is: % % LogInfo *GetLogInfo(const char *name,ExceptionInfo *exception) % % A description of each parameter follows: % % o name: the log name. % % o exception: return any errors or warnings in this structure. % */ static LogInfo *GetLogInfo(const char *name,ExceptionInfo *exception) { LogInfo *p; assert(exception != (ExceptionInfo *) NULL); if (IsLogCacheInstantiated(exception) == MagickFalse) return((LogInfo *) NULL); /* Search for log tag. */ LockSemaphoreInfo(log_semaphore); ResetLinkedListIterator(log_cache); p=(LogInfo *) GetNextValueInLinkedList(log_cache); if ((name == (const char *) NULL) || (LocaleCompare(name,"*") == 0)) { UnlockSemaphoreInfo(log_semaphore); return(p); } while (p != (LogInfo *) NULL) { if (LocaleCompare(name,p->name) == 0) break; p=(LogInfo *) GetNextValueInLinkedList(log_cache); } if (p != (LogInfo *) NULL) (void) InsertValueInLinkedList(log_cache,0, RemoveElementByValueFromLinkedList(log_cache,p)); UnlockSemaphoreInfo(log_semaphore); return(p); } /* %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % % % % % G e t L o g I n f o L i s t % % % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % GetLogInfoList() returns any logs that match the specified pattern. % % The format of the GetLogInfoList function is: % % const LogInfo **GetLogInfoList(const char *pattern, % size_t *number_preferences,ExceptionInfo *exception) % % A description of each parameter follows: % % o pattern: Specifies a pointer to a text string containing a pattern. % % o number_preferences: This integer returns the number of logs in the list. % % o exception: return any errors or warnings in this structure. % */ #if defined(__cplusplus) || defined(c_plusplus) extern "C" { #endif static int LogInfoCompare(const void *x,const void *y) { const LogInfo **p, **q; p=(const LogInfo **) x, q=(const LogInfo **) y; if (LocaleCompare((*p)->path,(*q)->path) == 0) return(LocaleCompare((*p)->name,(*q)->name)); return(LocaleCompare((*p)->path,(*q)->path)); } #if defined(__cplusplus) || defined(c_plusplus) } #endif MagickExport const LogInfo **GetLogInfoList(const char *pattern, size_t *number_preferences,ExceptionInfo *exception) { const LogInfo **preferences; const LogInfo *p; ssize_t i; /* Allocate log list. */ assert(pattern != (char *) NULL); (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",pattern); assert(number_preferences != (size_t *) NULL); *number_preferences=0; p=GetLogInfo("*",exception); if (p == (const LogInfo *) NULL) return((const LogInfo **) NULL); preferences=(const LogInfo **) AcquireQuantumMemory((size_t) GetNumberOfElementsInLinkedList(log_cache)+1UL,sizeof(*preferences)); if (preferences == (const LogInfo **) NULL) return((const LogInfo **) NULL); /* Generate log list. */ LockSemaphoreInfo(log_semaphore); ResetLinkedListIterator(log_cache); p=(const LogInfo *) GetNextValueInLinkedList(log_cache); for (i=0; p != (const LogInfo *) NULL; ) { if ((p->stealth == MagickFalse) && (GlobExpression(p->name,pattern,MagickFalse) != MagickFalse)) preferences[i++]=p; p=(const LogInfo *) GetNextValueInLinkedList(log_cache); } UnlockSemaphoreInfo(log_semaphore); qsort((void *) preferences,(size_t) i,sizeof(*preferences),LogInfoCompare); preferences[i]=(LogInfo *) NULL; *number_preferences=(size_t) i; return(preferences); } /* %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % % % % % G e t L o g L i s t % % % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % GetLogList() returns any logs that match the specified pattern. % % The format of the GetLogList function is: % % char **GetLogList(const char *pattern,size_t *number_preferences, % ExceptionInfo *exception) % % A description of each parameter follows: % % o pattern: Specifies a pointer to a text string containing a pattern. % % o number_preferences: This integer returns the number of logs in the list. % % o exception: return any errors or warnings in this structure. % */ #if defined(__cplusplus) || defined(c_plusplus) extern "C" { #endif static int LogCompare(const void *x,const void *y) { const char **p, **q; p=(const char **) x; q=(const char **) y; return(LocaleCompare(*p,*q)); } #if defined(__cplusplus) || defined(c_plusplus) } #endif MagickExport char **GetLogList(const char *pattern,size_t *number_preferences, ExceptionInfo *exception) { char **preferences; const LogInfo *p; ssize_t i; /* Allocate log list. */ assert(pattern != (char *) NULL); (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",pattern); assert(number_preferences != (size_t *) NULL); *number_preferences=0; p=GetLogInfo("*",exception); if (p == (const LogInfo *) NULL) return((char **) NULL); preferences=(char **) AcquireQuantumMemory((size_t) GetNumberOfElementsInLinkedList(log_cache)+1UL,sizeof(*preferences)); if (preferences == (char **) NULL) return((char **) NULL); /* Generate log list. */ LockSemaphoreInfo(log_semaphore); ResetLinkedListIterator(log_cache); p=(const LogInfo *) GetNextValueInLinkedList(log_cache); for (i=0; p != (const LogInfo *) NULL; ) { if ((p->stealth == MagickFalse) && (GlobExpression(p->name,pattern,MagickFalse) != MagickFalse)) preferences[i++]=ConstantString(p->name); p=(const LogInfo *) GetNextValueInLinkedList(log_cache); } UnlockSemaphoreInfo(log_semaphore); qsort((void *) preferences,(size_t) i,sizeof(*preferences),LogCompare); preferences[i]=(char *) NULL; *number_preferences=(size_t) i; return(preferences); } /* %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % % % % % G e t L o g N a m e % % % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % GetLogName() returns the current log name. % % The format of the GetLogName method is: % % const char *GetLogName(void) % */ MagickExport const char *GetLogName(void) { return(log_name); } /* %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % % % % + I s L o g C a c h e I n s t a n t i a t e d % % % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % IsLogCacheInstantiated() determines if the log list is instantiated. If % not, it instantiates the list and returns it. % % The format of the IsLogInstantiated method is: % % MagickBooleanType IsLogCacheInstantiated(ExceptionInfo *exception) % % A description of each parameter follows. % % o exception: return any errors or warnings in this structure. % */ static inline void CheckEventLogging() { /* Are we logging events? */ if (IsLinkedListEmpty(log_cache) != MagickFalse) event_logging=MagickFalse; else { LogInfo *p; ResetLinkedListIterator(log_cache); p=(LogInfo *) GetNextValueInLinkedList(log_cache); event_logging=(p != (LogInfo *) NULL) && (p->event_mask != NoEvents) ? MagickTrue: MagickFalse; } } static MagickBooleanType IsLogCacheInstantiated(ExceptionInfo *exception) { if (log_cache == (LinkedListInfo *) NULL) { if (log_semaphore == (SemaphoreInfo *) NULL) ActivateSemaphoreInfo(&log_semaphore); LockSemaphoreInfo(log_semaphore); if (log_cache == (LinkedListInfo *) NULL) { log_cache=AcquireLogCache(LogFilename,exception); CheckEventLogging(); } UnlockSemaphoreInfo(log_semaphore); } return(log_cache != (LinkedListInfo *) NULL ? MagickTrue : MagickFalse); } /* %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % % % % % I s E v e n t L o g g i n g % % % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % IsEventLogging() returns MagickTrue if debug of events is enabled otherwise % MagickFalse. % % The format of the IsEventLogging method is: % % MagickBooleanType IsEventLogging(void) % */ MagickExport MagickBooleanType IsEventLogging(void) { return(event_logging); } /* %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % % % % % L i s t L o g I n f o % % % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % ListLogInfo() lists the log info to a file. % % The format of the ListLogInfo method is: % % MagickBooleanType ListLogInfo(FILE *file,ExceptionInfo *exception) % % A description of each parameter follows. % % o file: An pointer to a FILE. % % o exception: return any errors or warnings in this structure. % */ MagickExport MagickBooleanType ListLogInfo(FILE *file,ExceptionInfo *exception) { #define MegabytesToBytes(value) ((MagickSizeType) (value)*1024*1024) const char *path; const LogInfo **log_info; ssize_t i; size_t number_aliases; ssize_t j; if (file == (const FILE *) NULL) file=stdout; log_info=GetLogInfoList("*",&number_aliases,exception); if (log_info == (const LogInfo **) NULL) return(MagickFalse); j=0; path=(const char *) NULL; for (i=0; i < (ssize_t) number_aliases; i++) { if (log_info[i]->stealth != MagickFalse) continue; if ((path == (const char *) NULL) || (LocaleCompare(path,log_info[i]->path) != 0)) { size_t length; if (log_info[i]->path != (char *) NULL) (void) FormatLocaleFile(file,"\nPath: %s\n\n",log_info[i]->path); length=0; for (j=0; j < (ssize_t) (8*sizeof(LogHandlerType)); j++) { size_t mask; if (*LogHandlers[j].name == '\0') break; mask=1; mask<<=j; if ((log_info[i]->handler_mask & mask) != 0) { (void) FormatLocaleFile(file,"%s ",LogHandlers[j].name); length+=strlen(LogHandlers[j].name); } } for (j=(ssize_t) length; j <= 12; j++) (void) FormatLocaleFile(file," "); (void) FormatLocaleFile(file," Generations Limit Format\n"); (void) FormatLocaleFile(file,"-----------------------------------------" "--------------------------------------\n"); } path=log_info[i]->path; if (log_info[i]->filename != (char *) NULL) { (void) FormatLocaleFile(file,"%s",log_info[i]->filename); for (j=(ssize_t) strlen(log_info[i]->filename); j <= 16; j++) (void) FormatLocaleFile(file," "); } (void) FormatLocaleFile(file,"%9g ",(double) log_info[i]->generations); (void) FormatLocaleFile(file,"%8g ",(double) log_info[i]->limit); if (log_info[i]->format != (char *) NULL) (void) FormatLocaleFile(file,"%s",log_info[i]->format); (void) FormatLocaleFile(file,"\n"); } (void) fflush(file); log_info=(const LogInfo **) RelinquishMagickMemory((void *) log_info); return(MagickTrue); } #if !MAGICKCORE_ZERO_CONFIGURATION_SUPPORT /* %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % % % % % % L o a d L o g C a c h e % % % % % % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % LoadLogCache() loads the log configurations which provides a % mapping between log attributes and log name. % % The format of the LoadLogCache method is: % % MagickBooleanType LoadLogCache(LinkedListInfo *cache,const char *xml, % const char *filename,const size_t depth,ExceptionInfo *exception) % % A description of each parameter follows: % % o xml: The log list in XML format. % % o filename: The log list filename. % % o depth: depth of statements. % % o exception: return any errors or warnings in this structure. % */ static MagickBooleanType LoadLogCache(LinkedListInfo *cache,const char *xml, const char *filename,const size_t depth,ExceptionInfo *exception) { char keyword[MagickPathExtent], *token; const char *q; LogInfo *log_info = (LogInfo *) NULL; MagickStatusType status; size_t extent; /* Load the log map file. */ if (xml == (const char *) NULL) return(MagickFalse); status=MagickTrue; token=AcquireString(xml); extent=strlen(token)+MagickPathExtent; for (q=(const char *) xml; *q != '\0'; ) { /* Interpret XML. */ (void) GetNextToken(q,&q,extent,token); if (*token == '\0') break; (void) CopyMagickString(keyword,token,MagickPathExtent); if (LocaleNCompare(keyword,"",2) != 0) && (*q != '\0')) (void) GetNextToken(q,&q,extent,token); continue; } if (LocaleNCompare(keyword,"