/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% DDDD EEEEE L EEEEE GGGG AAA TTTTT EEEEE %
% D D E L E G A A T E %
% D D EEE L EEE G GG AAAAA T EEE %
% D D E L E G G A A T E %
% DDDD EEEEE LLLLL EEEEE GGG A A T EEEEE %
% %
% %
% MagickCore Methods to Read/Write/Invoke Delegates %
% %
% Software Design %
% Cristy %
% October 1998 %
% %
% %
% Copyright 1999-2015 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 %
% %
% http://www.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. %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% The Delegates methods associate a set of commands with a particular
% image format. ImageMagick uses delegates for formats it does not handle
% directly.
%
% Thanks to Bob Friesenhahn for the initial inspiration and design of the
% delegates methods.
%
%
*/
/*
Include declarations.
*/
#include "MagickCore/studio.h"
#include "MagickCore/property.h"
#include "MagickCore/blob.h"
#include "MagickCore/client.h"
#include "MagickCore/configure.h"
#include "MagickCore/constitute.h"
#include "MagickCore/delegate.h"
#include "MagickCore/delegate-private.h"
#include "MagickCore/exception.h"
#include "MagickCore/exception-private.h"
#include "MagickCore/hashmap.h"
#include "MagickCore/image-private.h"
#include "MagickCore/list.h"
#include "MagickCore/memory_.h"
#include "MagickCore/nt-base-private.h"
#include "MagickCore/policy.h"
#include "MagickCore/resource_.h"
#include "MagickCore/semaphore.h"
#include "MagickCore/string_.h"
#include "MagickCore/token.h"
#include "MagickCore/utility.h"
#include "MagickCore/utility-private.h"
#include "MagickCore/xml-tree.h"
#include "MagickCore/xml-tree-private.h"
/*
Define declarations.
*/
#define DelegateFilename "delegates.xml"
/*
Declare delegate map.
*/
static const char
*DelegateMap = (const char *)
""
""
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
"";
/*
Global declaractions.
*/
static LinkedListInfo
*delegate_cache = (LinkedListInfo *) NULL;
static SemaphoreInfo
*delegate_semaphore = (SemaphoreInfo *) NULL;
/*
Forward declaractions.
*/
static MagickBooleanType
IsDelegateCacheInstantiated(ExceptionInfo *),
LoadDelegateCache(LinkedListInfo *,const char *,const char *,const size_t,
ExceptionInfo *);
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
% A c q u i r e D e l e g a t e C a c h e %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% AcquireDelegateCache() caches one or more delegate configurations which
% provides a mapping between delegate attributes and a delegate name.
%
% The format of the AcquireDelegateCache method is:
%
% LinkedListInfo *AcquireDelegateCache(const char *filename,
% ExceptionInfo *exception)
%
% A description of each parameter follows:
%
% o filename: the font file name.
%
% o exception: return any errors or warnings in this structure.
%
*/
static LinkedListInfo *AcquireDelegateCache(const char *filename,
ExceptionInfo *exception)
{
LinkedListInfo
*delegate_cache;
MagickStatusType
status;
delegate_cache=NewLinkedList(0);
if (delegate_cache == (LinkedListInfo *) NULL)
ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
status=MagickTrue;
#if !defined(MAGICKCORE_ZERO_CONFIGURATION_SUPPORT)
{
const StringInfo
*option;
LinkedListInfo
*options;
options=GetConfigureOptions(filename,exception);
option=(const StringInfo *) GetNextValueInLinkedList(options);
while (option != (const StringInfo *) NULL)
{
status&=LoadDelegateCache(delegate_cache,(const char *)
GetStringInfoDatum(option),GetStringInfoPath(option),0,exception);
option=(const StringInfo *) GetNextValueInLinkedList(options);
}
options=DestroyConfigureOptions(options);
}
#endif
if (IfMagickTrue(IsLinkedListEmpty(delegate_cache)))
status&=LoadDelegateCache(delegate_cache,DelegateMap,"built-in",0,
exception);
return(delegate_cache);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
+ D e l e g a t e C o m p o n e n t G e n e s i s %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% DelegateComponentGenesis() instantiates the delegate component.
%
% The format of the DelegateComponentGenesis method is:
%
% MagickBooleanType DelegateComponentGenesis(void)
%
*/
MagickPrivate MagickBooleanType DelegateComponentGenesis(void)
{
if (delegate_semaphore == (SemaphoreInfo *) NULL)
delegate_semaphore=AcquireSemaphoreInfo();
return(MagickTrue);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
% D e l e g a t e C o m p o n e n t T e r m i n u s %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% DelegateComponentTerminus() destroys the delegate component.
%
% The format of the DelegateComponentTerminus method is:
%
% DelegateComponentTerminus(void)
%
*/
static void *DestroyDelegate(void *delegate_info)
{
register DelegateInfo
*p;
p=(DelegateInfo *) delegate_info;
if (p->path != (char *) NULL)
p->path=DestroyString(p->path);
if (p->decode != (char *) NULL)
p->decode=DestroyString(p->decode);
if (p->encode != (char *) NULL)
p->encode=DestroyString(p->encode);
if (p->commands != (char *) NULL)
p->commands=DestroyString(p->commands);
if (p->semaphore != (SemaphoreInfo *) NULL)
RelinquishSemaphoreInfo(&p->semaphore);
p=(DelegateInfo *) RelinquishMagickMemory(p);
return((void *) NULL);
}
MagickPrivate void DelegateComponentTerminus(void)
{
if (delegate_semaphore == (SemaphoreInfo *) NULL)
ActivateSemaphoreInfo(&delegate_semaphore);
LockSemaphoreInfo(delegate_semaphore);
if (delegate_cache != (LinkedListInfo *) NULL)
delegate_cache=DestroyLinkedList(delegate_cache,DestroyDelegate);
UnlockSemaphoreInfo(delegate_semaphore);
RelinquishSemaphoreInfo(&delegate_semaphore);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
+ E x t e r n a l D e l e g a t e C o m m a n d %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% ExternalDelegateCommand() executes the specified command and waits until it
% terminates. The returned value is the exit status of the command.
%
% The format of the ExternalDelegateCommand method is:
%
% int ExternalDelegateCommand(const MagickBooleanType asynchronous,
% const MagickBooleanType verbose,const char *command,
% char *message,ExceptionInfo *exception)
%
% A description of each parameter follows:
%
% o asynchronous: a value other than 0 executes the parent program
% concurrently with the new child process.
%
% o verbose: a value other than 0 prints the executed command before it is
% invoked.
%
% o command: this string is the command to execute.
%
% o message: an option buffer to receive any message posted to stdout or
% stderr.
%
% o exception: return any errors here.
%
*/
static char *SanitizeDelegateCommand(const char *command)
{
char
*sanitize_command;
const char
*q;
register char
*p;
static char
whitelist[] =
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_- "
".@&;<>()|/\\\'\":%=~`";
sanitize_command=AcquireString(command);
p=sanitize_command;
q=sanitize_command+strlen(sanitize_command);
for (p+=strspn(p,whitelist); p != q; p+=strspn(p,whitelist))
*p='_';
return(sanitize_command);
}
MagickExport int ExternalDelegateCommand(const MagickBooleanType asynchronous,
const MagickBooleanType verbose,const char *command,char *message,
ExceptionInfo *exception)
{
char
**arguments,
*sanitize_command;
int
number_arguments,
status;
PolicyDomain
domain;
PolicyRights
rights;
register ssize_t
i;
status=(-1);
arguments=StringToArgv(command,&number_arguments);
if (arguments == (char **) NULL)
return(status);
if (*arguments[1] == '\0')
{
for (i=0; i < (ssize_t) number_arguments; i++)
arguments[i]=DestroyString(arguments[i]);
arguments=(char **) RelinquishMagickMemory(arguments);
return(-1);
}
rights=ExecutePolicyRights;
domain=DelegatePolicyDomain;
if (IsRightsAuthorized(domain,rights,arguments[1]) == MagickFalse)
{
errno=EPERM;
(void) ThrowMagickException(exception,GetMagickModule(),PolicyError,
"NotAuthorized","`%s'",arguments[1]);
for (i=0; i < (ssize_t) number_arguments; i++)
arguments[i]=DestroyString(arguments[i]);
arguments=(char **) RelinquishMagickMemory(arguments);
return(-1);
}
if (verbose != MagickFalse)
{
(void) FormatLocaleFile(stderr,"%s\n",command);
(void) fflush(stderr);
}
sanitize_command=SanitizeDelegateCommand(command);
if (asynchronous != MagickFalse)
(void) ConcatenateMagickString(sanitize_command,"&",MagickPathExtent);
if (message != (char *) NULL)
*message='\0';
#if defined(MAGICKCORE_POSIX_SUPPORT)
#if !defined(MAGICKCORE_HAVE_EXECVP)
status=system(sanitize_command);
#else
if ((asynchronous != MagickFalse) ||
(strpbrk(sanitize_command,"&;<>|") != (char *) NULL))
status=system(sanitize_command);
else
{
pid_t
child_pid;
/*
Call application directly rather than from a shell.
*/
child_pid=(pid_t) fork();
if (child_pid == (pid_t) -1)
status=system(sanitize_command);
else
if (child_pid == 0)
{
status=execvp(arguments[1],arguments+1);
_exit(1);
}
else
{
int
child_status;
pid_t
pid;
child_status=0;
pid=(pid_t) waitpid(child_pid,&child_status,0);
if (pid == -1)
status=(-1);
else
{
if (WIFEXITED(child_status) != 0)
status=WEXITSTATUS(child_status);
else
if (WIFSIGNALED(child_status))
status=(-1);
}
}
}
#endif
#elif defined(MAGICKCORE_WINDOWS_SUPPORT)
{
register char
*p;
/*
If a command shell is executed we need to change the forward slashes in
files to a backslash. We need to do this to keep Windows happy when we
want to 'move' a file.
TODO: This won't work if one of the delegate parameters has a forward
slash as aparameter.
*/
p=strstr(sanitize_command, "cmd.exe /c");
if (p != (char*) NULL)
{
p+=10;
for (; *p != '\0'; p++)
if (*p == '/')
*p=*DirectorySeparator;
}
}
status=NTSystemCommand(sanitize_command,message);
#elif defined(macintosh)
status=MACSystemCommand(sanitize_command);
#elif defined(vms)
status=system(sanitize_command);
#else
# error No suitable system() method.
#endif
if (status < 0)
{
if ((message != (char *) NULL) && (*message != '\0'))
(void) ThrowMagickException(exception,GetMagickModule(),DelegateError,
"FailedToExecuteCommand","`%s' (%s)",sanitize_command,message);
else
(void) ThrowMagickException(exception,GetMagickModule(),DelegateError,
"FailedToExecuteCommand","`%s' (%d)",sanitize_command,status);
}
sanitize_command=DestroyString(sanitize_command);
for (i=0; i < (ssize_t) number_arguments; i++)
arguments[i]=DestroyString(arguments[i]);
arguments=(char **) RelinquishMagickMemory(arguments);
return(status);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
% G e t D e l e g a t e C o m m a n d %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% GetDelegateCommand() replaces any embedded formatting characters with the
% appropriate image attribute and returns the resulting command.
%
% The format of the GetDelegateCommand method is:
%
% char *GetDelegateCommand(const ImageInfo *image_info,Image *image,
% const char *decode,const char *encode,ExceptionInfo *exception)
%
% A description of each parameter follows:
%
% o command: Method GetDelegateCommand returns the command associated
% with specified delegate tag.
%
% o image_info: the image info.
%
% o image: the image.
%
% o decode: Specifies the decode delegate we are searching for as a
% character string.
%
% o encode: Specifies the encode delegate we are searching for as a
% character string.
%
% o exception: return any errors or warnings in this structure.
%
*/
MagickExport char *GetDelegateCommand(const ImageInfo *image_info,Image *image,
const char *decode,const char *encode,ExceptionInfo *exception)
{
char
*command,
**commands;
const DelegateInfo
*delegate_info;
register ssize_t
i;
assert(image_info != (ImageInfo *) NULL);
assert(image_info->signature == MagickCoreSignature);
assert(image != (Image *) NULL);
assert(image->signature == MagickCoreSignature);
if (image->debug != MagickFalse)
(void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
delegate_info=GetDelegateInfo(decode,encode,exception);
if (delegate_info == (const DelegateInfo *) NULL)
{
(void) ThrowMagickException(exception,GetMagickModule(),DelegateError,
"NoTagFound","`%s'",decode ? decode : encode);
return((char *) NULL);
}
commands=StringToList(delegate_info->commands);
if (commands == (char **) NULL)
{
(void) ThrowMagickException(exception,GetMagickModule(),
ResourceLimitError,"MemoryAllocationFailed","`%s'",decode ? decode :
encode);
return((char *) NULL);
}
command=InterpretImageProperties((ImageInfo *) image_info,image,commands[0],
exception);
if (command == (char *) NULL)
(void) ThrowMagickException(exception,GetMagickModule(),ResourceLimitError,
"MemoryAllocationFailed","`%s'",commands[0]);
/*
Relinquish resources.
*/
for (i=0; commands[i] != (char *) NULL; i++)
commands[i]=DestroyString(commands[i]);
commands=(char **) RelinquishMagickMemory(commands);
return(command);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
% G e t D e l e g a t e C o m m a n d s %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% GetDelegateCommands() returns the commands associated with a delegate.
%
% The format of the GetDelegateCommands method is:
%
% const char *GetDelegateCommands(const DelegateInfo *delegate_info)
%
% A description of each parameter follows:
%
% o delegate_info: The delegate info.
%
*/
MagickExport const char *GetDelegateCommands(const DelegateInfo *delegate_info)
{
(void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
assert(delegate_info != (DelegateInfo *) NULL);
assert(delegate_info->signature == MagickCoreSignature);
return(delegate_info->commands);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
% G e t D e l e g a t e I n f o %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% GetDelegateInfo() returns any delegates associated with the specified tag.
%
% The format of the GetDelegateInfo method is:
%
% const DelegateInfo *GetDelegateInfo(const char *decode,
% const char *encode,ExceptionInfo *exception)
%
% A description of each parameter follows:
%
% o decode: Specifies the decode delegate we are searching for as a
% character string.
%
% o encode: Specifies the encode delegate we are searching for as a
% character string.
%
% o exception: return any errors or warnings in this structure.
%
*/
MagickExport const DelegateInfo *GetDelegateInfo(const char *decode,
const char *encode,ExceptionInfo *exception)
{
register const DelegateInfo
*p;
assert(exception != (ExceptionInfo *) NULL);
if (IfMagickFalse(IsDelegateCacheInstantiated(exception)))
return((const DelegateInfo *) NULL);
/*
Search for named delegate.
*/
LockSemaphoreInfo(delegate_semaphore);
ResetLinkedListIterator(delegate_cache);
p=(const DelegateInfo *) GetNextValueInLinkedList(delegate_cache);
if ((LocaleCompare(decode,"*") == 0) && (LocaleCompare(encode,"*") == 0))
{
UnlockSemaphoreInfo(delegate_semaphore);
return(p);
}
while (p != (const DelegateInfo *) NULL)
{
if (p->mode > 0)
{
if (LocaleCompare(p->decode,decode) == 0)
break;
p=(const DelegateInfo *) GetNextValueInLinkedList(delegate_cache);
continue;
}
if (p->mode < 0)
{
if (LocaleCompare(p->encode,encode) == 0)
break;
p=(const DelegateInfo *) GetNextValueInLinkedList(delegate_cache);
continue;
}
if (LocaleCompare(decode,p->decode) == 0)
if (LocaleCompare(encode,p->encode) == 0)
break;
if (LocaleCompare(decode,"*") == 0)
if (LocaleCompare(encode,p->encode) == 0)
break;
if (LocaleCompare(decode,p->decode) == 0)
if (LocaleCompare(encode,"*") == 0)
break;
p=(const DelegateInfo *) GetNextValueInLinkedList(delegate_cache);
}
if (p != (const DelegateInfo *) NULL)
(void) InsertValueInLinkedList(delegate_cache,0,
RemoveElementByValueFromLinkedList(delegate_cache,p));
UnlockSemaphoreInfo(delegate_semaphore);
return(p);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
% G e t D e l e g a t e I n f o L i s t %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% GetDelegateInfoList() returns any delegates that match the specified pattern.
%
% The delegate of the GetDelegateInfoList function is:
%
% const DelegateInfo **GetDelegateInfoList(const char *pattern,
% size_t *number_delegates,ExceptionInfo *exception)
%
% A description of each parameter follows:
%
% o pattern: Specifies a pointer to a text string containing a pattern.
%
% o number_delegates: This integer returns the number of delegates in the
% list.
%
% o exception: return any errors or warnings in this structure.
%
*/
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
static int DelegateInfoCompare(const void *x,const void *y)
{
const DelegateInfo
**p,
**q;
int
cmp;
p=(const DelegateInfo **) x,
q=(const DelegateInfo **) y;
cmp=LocaleCompare((*p)->path,(*q)->path);
if (cmp == 0)
{
if ((*p)->decode == (char *) NULL)
if (((*p)->encode != (char *) NULL) &&
((*q)->encode != (char *) NULL))
return(strcmp((*p)->encode,(*q)->encode));
if (((*p)->decode != (char *) NULL) &&
((*q)->decode != (char *) NULL))
return(strcmp((*p)->decode,(*q)->decode));
}
return(cmp);
}
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif
MagickExport const DelegateInfo **GetDelegateInfoList(const char *pattern,
size_t *number_delegates,ExceptionInfo *exception)
{
const DelegateInfo
**delegates;
register const DelegateInfo
*p;
register ssize_t
i;
/*
Allocate delegate list.
*/
assert(number_delegates != (size_t *) NULL);
assert(pattern != (char *) NULL);
(void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",pattern);
*number_delegates=0;
p=GetDelegateInfo("*","*",exception);
if (p == (const DelegateInfo *) NULL)
return((const DelegateInfo **) NULL);
delegates=(const DelegateInfo **) AcquireQuantumMemory((size_t)
GetNumberOfElementsInLinkedList(delegate_cache)+1UL,sizeof(*delegates));
if (delegates == (const DelegateInfo **) NULL)
return((const DelegateInfo **) NULL);
/*
Generate delegate list.
*/
LockSemaphoreInfo(delegate_semaphore);
ResetLinkedListIterator(delegate_cache);
p=(const DelegateInfo *) GetNextValueInLinkedList(delegate_cache);
for (i=0; p != (const DelegateInfo *) NULL; )
{
if( IfMagickFalse(p->stealth) &&
( IfMagickTrue(GlobExpression(p->decode,pattern,MagickFalse)) ||
IfMagickTrue(GlobExpression(p->encode,pattern,MagickFalse))) )
delegates[i++]=p;
p=(const DelegateInfo *) GetNextValueInLinkedList(delegate_cache);
}
UnlockSemaphoreInfo(delegate_semaphore);
qsort((void *) delegates,(size_t) i,sizeof(*delegates),DelegateInfoCompare);
delegates[i]=(DelegateInfo *) NULL;
*number_delegates=(size_t) i;
return(delegates);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
% G e t D e l e g a t e L i s t %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% GetDelegateList() returns any image format delegates that match the
% specified pattern.
%
% The format of the GetDelegateList function is:
%
% char **GetDelegateList(const char *pattern,
% size_t *number_delegates,ExceptionInfo *exception)
%
% A description of each parameter follows:
%
% o pattern: Specifies a pointer to a text string containing a pattern.
%
% o number_delegates: This integer returns the number of delegates
% in the list.
%
% o exception: return any errors or warnings in this structure.
%
*/
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
static int DelegateCompare(const void *x,const void *y)
{
register 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 **GetDelegateList(const char *pattern,
size_t *number_delegates,ExceptionInfo *exception)
{
char
**delegates;
register const DelegateInfo
*p;
register ssize_t
i;
/*
Allocate delegate list.
*/
assert(pattern != (char *) NULL);
(void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",pattern);
assert(number_delegates != (size_t *) NULL);
*number_delegates=0;
p=GetDelegateInfo("*","*",exception);
if (p == (const DelegateInfo *) NULL)
return((char **) NULL);
delegates=(char **) AcquireQuantumMemory((size_t)
GetNumberOfElementsInLinkedList(delegate_cache)+1UL,sizeof(*delegates));
if (delegates == (char **) NULL)
return((char **) NULL);
LockSemaphoreInfo(delegate_semaphore);
ResetLinkedListIterator(delegate_cache);
p=(const DelegateInfo *) GetNextValueInLinkedList(delegate_cache);
for (i=0; p != (const DelegateInfo *) NULL; )
{
if( IfMagickFalse(p->stealth) &&
IfMagickTrue(GlobExpression(p->decode,pattern,MagickFalse)) )
delegates[i++]=ConstantString(p->decode);
if( IfMagickFalse(p->stealth) &&
IfMagickTrue(GlobExpression(p->encode,pattern,MagickFalse)) )
delegates[i++]=ConstantString(p->encode);
p=(const DelegateInfo *) GetNextValueInLinkedList(delegate_cache);
}
UnlockSemaphoreInfo(delegate_semaphore);
qsort((void *) delegates,(size_t) i,sizeof(*delegates),DelegateCompare);
delegates[i]=(char *) NULL;
*number_delegates=(size_t) i;
return(delegates);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
% G e t D e l e g a t e M o d e %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% GetDelegateMode() returns the mode of the delegate.
%
% The format of the GetDelegateMode method is:
%
% ssize_t GetDelegateMode(const DelegateInfo *delegate_info)
%
% A description of each parameter follows:
%
% o delegate_info: The delegate info.
%
*/
MagickExport ssize_t GetDelegateMode(const DelegateInfo *delegate_info)
{
(void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
assert(delegate_info != (DelegateInfo *) NULL);
assert(delegate_info->signature == MagickCoreSignature);
return(delegate_info->mode);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
+ G e t D e l e g a t e T h r e a d S u p p o r t %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% GetDelegateThreadSupport() returns MagickTrue if the delegate supports
% threads.
%
% The format of the GetDelegateThreadSupport method is:
%
% MagickBooleanType GetDelegateThreadSupport(
% const DelegateInfo *delegate_info)
%
% A description of each parameter follows:
%
% o delegate_info: The delegate info.
%
*/
MagickExport MagickBooleanType GetDelegateThreadSupport(
const DelegateInfo *delegate_info)
{
(void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
assert(delegate_info != (DelegateInfo *) NULL);
assert(delegate_info->signature == MagickCoreSignature);
return(delegate_info->thread_support);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
+ I s D e l e g a t e C a c h e I n s t a n t i a t e d %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% IsDelegateCacheInstantiated() determines if the delegate cache is
% instantiated. If not, it instantiates the cache and returns it.
%
% The format of the IsDelegateInstantiated method is:
%
% MagickBooleanType IsDelegateCacheInstantiated(ExceptionInfo *exception)
%
% A description of each parameter follows.
%
% o exception: return any errors or warnings in this structure.
%
*/
static MagickBooleanType IsDelegateCacheInstantiated(ExceptionInfo *exception)
{
if (delegate_cache == (LinkedListInfo *) NULL)
{
if (delegate_semaphore == (SemaphoreInfo *) NULL)
ActivateSemaphoreInfo(&delegate_semaphore);
LockSemaphoreInfo(delegate_semaphore);
if (delegate_cache == (LinkedListInfo *) NULL)
delegate_cache=AcquireDelegateCache(DelegateFilename,exception);
UnlockSemaphoreInfo(delegate_semaphore);
}
return(delegate_cache != (LinkedListInfo *) NULL ? MagickTrue : MagickFalse);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
% I n v o k e D e l e g a t e %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% InvokeDelegate replaces any embedded formatting characters with the
% appropriate image attribute and executes the resulting command. MagickFalse
% is returned if the commands execute with success otherwise MagickTrue.
%
% The format of the InvokeDelegate method is:
%
% MagickBooleanType InvokeDelegate(ImageInfo *image_info,Image *image,
% const char *decode,const char *encode,ExceptionInfo *exception)
%
% A description of each parameter follows:
%
% o image_info: the imageInfo.
%
% o image: the image.
%
% o exception: return any errors or warnings in this structure.
%
*/
static MagickBooleanType CopyDelegateFile(const char *source,
const char *destination,const MagickBooleanType overwrite)
{
int
destination_file,
source_file;
MagickBooleanType
status;
register size_t
i;
size_t
length,
quantum;
ssize_t
count;
struct stat
attributes;
unsigned char
*buffer;
/*
Copy source file to destination.
*/
assert(source != (const char *) NULL);
assert(destination != (char *) NULL);
if (overwrite == MagickFalse)
{
status=GetPathAttributes(destination,&attributes);
if (status != MagickFalse)
return(MagickTrue);
}
destination_file=open_utf8(destination,O_WRONLY | O_BINARY | O_CREAT,S_MODE);
if (destination_file == -1)
return(MagickFalse);
source_file=open_utf8(source,O_RDONLY | O_BINARY,0);
if (source_file == -1)
{
(void) close(destination_file);
return(MagickFalse);
}
quantum=(size_t) MagickMaxBufferExtent;
if ((fstat(source_file,&attributes) == 0) && (attributes.st_size > 0))
quantum=MagickMin((size_t) attributes.st_size,MagickMaxBufferExtent);
buffer=(unsigned char *) AcquireQuantumMemory(quantum,sizeof(*buffer));
if (buffer == (unsigned char *) NULL)
{
(void) close(source_file);
(void) close(destination_file);
return(MagickFalse);
}
length=0;
for (i=0; ; i+=count)
{
count=(ssize_t) read(source_file,buffer,quantum);
if (count <= 0)
break;
length=(size_t) count;
count=(ssize_t) write(destination_file,buffer,length);
if ((size_t) count != length)
break;
}
(void) close(destination_file);
(void) close(source_file);
buffer=(unsigned char *) RelinquishMagickMemory(buffer);
return(i != 0 ? MagickTrue : MagickFalse);
}
MagickExport MagickBooleanType InvokeDelegate(ImageInfo *image_info,
Image *image,const char *decode,const char *encode,ExceptionInfo *exception)
{
char
*command,
**commands,
input_filename[MagickPathExtent],
output_filename[MagickPathExtent];
const DelegateInfo
*delegate_info;
MagickBooleanType
status,
temporary;
register ssize_t
i;
PolicyRights
rights;
/*
Get delegate.
*/
assert(image_info != (ImageInfo *) NULL);
assert(image_info->signature == MagickCoreSignature);
assert(image != (Image *) NULL);
assert(image->signature == MagickCoreSignature);
if (image->debug != MagickFalse)
(void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
rights=ExecutePolicyRights;
if (IsRightsAuthorized(DelegatePolicyDomain,rights,decode) == MagickFalse)
{
errno=EPERM;
(void) ThrowMagickException(exception,GetMagickModule(),PolicyError,
"NotAuthorized","`%s'",decode);
return(MagickFalse);
}
if (IsRightsAuthorized(DelegatePolicyDomain,rights,encode) == MagickFalse)
{
errno=EPERM;
(void) ThrowMagickException(exception,GetMagickModule(),PolicyError,
"NotAuthorized","`%s'",encode);
return(MagickFalse);
}
temporary=*image->filename == '\0' ? MagickTrue : MagickFalse;
if ((temporary != MagickFalse) && (AcquireUniqueFilename(image->filename) ==
MagickFalse))
{
ThrowFileException(exception,FileOpenError,"UnableToCreateTemporaryFile",
image->filename);
return(MagickFalse);
}
delegate_info=GetDelegateInfo(decode,encode,exception);
if (delegate_info == (DelegateInfo *) NULL)
{
if (temporary != MagickFalse)
(void) RelinquishUniqueFileResource(image->filename);
(void) ThrowMagickException(exception,GetMagickModule(),DelegateError,
"NoTagFound","`%s'",decode ? decode : encode);
return(MagickFalse);
}
if (*image_info->filename == '\0')
{
if (AcquireUniqueFilename(image_info->filename) == MagickFalse)
{
if (temporary != MagickFalse)
(void) RelinquishUniqueFileResource(image->filename);
ThrowFileException(exception,FileOpenError,
"UnableToCreateTemporaryFile",image_info->filename);
return(MagickFalse);
}
image_info->temporary=MagickTrue;
}
if ((delegate_info->mode != 0) && (((decode != (const char *) NULL) &&
(delegate_info->encode != (char *) NULL)) ||
((encode != (const char *) NULL) &&
(delegate_info->decode != (char *) NULL))))
{
char
*magick;
ImageInfo
*clone_info;
register Image
*p;
/*
Delegate requires a particular image format.
*/
if (AcquireUniqueFilename(image_info->unique) == MagickFalse)
{
ThrowFileException(exception,FileOpenError,
"UnableToCreateTemporaryFile",image_info->unique);
return(MagickFalse);
}
if (AcquireUniqueFilename(image_info->zero) == MagickFalse)
{
(void) RelinquishUniqueFileResource(image_info->unique);
ThrowFileException(exception,FileOpenError,
"UnableToCreateTemporaryFile",image_info->zero);
return(MagickFalse);
}
magick=InterpretImageProperties(image_info,image,decode != (char *) NULL ?
delegate_info->encode : delegate_info->decode,exception);
if (magick == (char *) NULL)
{
(void) RelinquishUniqueFileResource(image_info->unique);
(void) RelinquishUniqueFileResource(image_info->zero);
if (temporary != MagickFalse)
(void) RelinquishUniqueFileResource(image->filename);
(void) ThrowMagickException(exception,GetMagickModule(),
DelegateError,"DelegateFailed","`%s'",decode ? decode : encode);
return(MagickFalse);
}
LocaleUpper(magick);
clone_info=CloneImageInfo(image_info);
(void) CopyMagickString((char *) clone_info->magick,magick,
MagickPathExtent);
if (LocaleCompare(magick,"NULL") != 0)
(void) CopyMagickString(image->magick,magick,MagickPathExtent);
magick=DestroyString(magick);
(void) FormatLocaleString(clone_info->filename,MagickPathExtent,"%s:",
delegate_info->decode);
(void) SetImageInfo(clone_info,(unsigned int) GetImageListLength(image),
exception);
(void) CopyMagickString(clone_info->filename,image_info->filename,
MagickPathExtent);
(void) CopyMagickString(image_info->filename,image->filename,
MagickPathExtent);
for (p=image; p != (Image *) NULL; p=GetNextImageInList(p))
{
(void) FormatLocaleString(p->filename,MagickPathExtent,"%s:%s",
delegate_info->decode,clone_info->filename);
status=WriteImage(clone_info,p,exception);
if (status == MagickFalse)
{
(void) RelinquishUniqueFileResource(image_info->unique);
(void) RelinquishUniqueFileResource(image_info->zero);
if (temporary != MagickFalse)
(void) RelinquishUniqueFileResource(image->filename);
clone_info=DestroyImageInfo(clone_info);
(void) ThrowMagickException(exception,GetMagickModule(),
DelegateError,"DelegateFailed","`%s'",decode ? decode : encode);
return(MagickFalse);
}
if (clone_info->adjoin != MagickFalse)
break;
}
(void) RelinquishUniqueFileResource(image_info->unique);
(void) RelinquishUniqueFileResource(image_info->zero);
clone_info=DestroyImageInfo(clone_info);
}
/*
Invoke delegate.
*/
commands=StringToList(delegate_info->commands);
if (commands == (char **) NULL)
{
if( IfMagickTrue(temporary) )
(void) RelinquishUniqueFileResource(image->filename);
(void) ThrowMagickException(exception,GetMagickModule(),
ResourceLimitError,"MemoryAllocationFailed","`%s'",
decode ? decode : encode);
return(MagickFalse);
}
command=(char *) NULL;
status=MagickTrue;
(void) CopyMagickString(output_filename,image_info->filename,
MagickPathExtent);
(void) CopyMagickString(input_filename,image->filename,MagickPathExtent);
for (i=0; commands[i] != (char *) NULL; i++)
{
(void) AcquireUniqueSymbolicLink(output_filename,image_info->filename);
if (AcquireUniqueFilename(image_info->unique) == MagickFalse)
{
ThrowFileException(exception,FileOpenError,
"UnableToCreateTemporaryFile",image_info->unique);
break;
}
if (AcquireUniqueFilename(image_info->zero) == MagickFalse)
{
(void) RelinquishUniqueFileResource(image_info->unique);
ThrowFileException(exception,FileOpenError,
"UnableToCreateTemporaryFile",image_info->zero);
break;
}
if (LocaleCompare(decode,"SCAN") != 0)
{
status=AcquireUniqueSymbolicLink(input_filename,image->filename);
if (status == MagickFalse)
{
ThrowFileException(exception,FileOpenError,
"UnableToCreateTemporaryFile",input_filename);
break;
}
}
status=MagickTrue;
command=InterpretImageProperties(image_info,image,commands[i],exception);
if (command != (char *) NULL)
{
/*
Execute delegate.
*/
if (ExternalDelegateCommand(delegate_info->spawn,image_info->verbose,
command,(char *) NULL,exception) != 0)
status=MagickFalse;
if (delegate_info->spawn != MagickFalse)
{
ssize_t
count;
/*
Wait for input file to 'disappear', or maximum 10 seconds.
*/
count=100;
while ((count-- > 0) && (access_utf8(image->filename,F_OK) == 0))
(void) MagickDelay(100); /* sleep 0.1 seconds */
}
command=DestroyString(command);
}
if (LocaleCompare(decode,"SCAN") != 0)
{
if (CopyDelegateFile(image->filename,input_filename,MagickFalse) == MagickFalse)
(void) RelinquishUniqueFileResource(input_filename);
}
if (CopyDelegateFile(image_info->filename,output_filename,MagickTrue) == MagickFalse)
(void) RelinquishUniqueFileResource(output_filename);
if (image_info->temporary != MagickFalse)
(void) RelinquishUniqueFileResource(image_info->filename);
(void) RelinquishUniqueFileResource(image_info->unique);
(void) RelinquishUniqueFileResource(image_info->zero);
(void) RelinquishUniqueFileResource(image_info->filename);
(void) RelinquishUniqueFileResource(image->filename);
if (status == MagickFalse)
{
(void) ThrowMagickException(exception,GetMagickModule(),DelegateError,
"DelegateFailed","`%s'",commands[i]);
break;
}
commands[i]=DestroyString(commands[i]);
}
(void) CopyMagickString(image_info->filename,output_filename,MagickPathExtent);
(void) CopyMagickString(image->filename,input_filename,MagickPathExtent);
/*
Relinquish resources.
*/
for ( ; commands[i] != (char *) NULL; i++)
commands[i]=DestroyString(commands[i]);
commands=(char **) RelinquishMagickMemory(commands);
if (temporary != MagickFalse)
(void) RelinquishUniqueFileResource(image->filename);
return(status);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
% L i s t D e l e g a t e I n f o %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% ListDelegateInfo() lists the image formats to a file.
%
% The format of the ListDelegateInfo method is:
%
% MagickBooleanType ListDelegateInfo(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 ListDelegateInfo(FILE *file,
ExceptionInfo *exception)
{
const DelegateInfo
**delegate_info;
char
**commands,
delegate[MagickPathExtent];
const char
*path;
register ssize_t
i;
size_t
number_delegates;
ssize_t
j;
if (file == (const FILE *) NULL)
file=stdout;
delegate_info=GetDelegateInfoList("*",&number_delegates,exception);
if (delegate_info == (const DelegateInfo **) NULL)
return(MagickFalse);
path=(const char *) NULL;
for (i=0; i < (ssize_t) number_delegates; i++)
{
if( IfMagickTrue(delegate_info[i]->stealth) )
continue;
if ((path == (const char *) NULL) ||
(LocaleCompare(path,delegate_info[i]->path) != 0))
{
if (delegate_info[i]->path != (char *) NULL)
(void) FormatLocaleFile(file,"\nPath: %s\n\n",delegate_info[i]->path);
(void) FormatLocaleFile(file,"Delegate Command\n");
(void) FormatLocaleFile(file,
"-------------------------------------------------"
"------------------------------\n");
}
path=delegate_info[i]->path;
*delegate='\0';
if (delegate_info[i]->encode != (char *) NULL)
(void) CopyMagickString(delegate,delegate_info[i]->encode,MagickPathExtent);
(void) ConcatenateMagickString(delegate," ",MagickPathExtent);
delegate[8]='\0';
commands=StringToList(delegate_info[i]->commands);
if (commands == (char **) NULL)
continue;
(void) FormatLocaleFile(file,"%11s%c=%c%s ",delegate_info[i]->decode ?
delegate_info[i]->decode : "",delegate_info[i]->mode <= 0 ? '<' : ' ',
delegate_info[i]->mode >= 0 ? '>' : ' ',delegate);
StripString(commands[0]);
(void) FormatLocaleFile(file,"\"%s\"\n",commands[0]);
for (j=1; commands[j] != (char *) NULL; j++)
{
StripString(commands[j]);
(void) FormatLocaleFile(file," \"%s\"\n",commands[j]);
}
for (j=0; commands[j] != (char *) NULL; j++)
commands[j]=DestroyString(commands[j]);
commands=(char **) RelinquishMagickMemory(commands);
}
(void) fflush(file);
delegate_info=(const DelegateInfo **)
RelinquishMagickMemory((void *) delegate_info);
return(MagickTrue);
}
/*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
% %
% %
+ L o a d D e l e g a t e L i s t %
% %
% %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% LoadDelegateCache() loads the delegate configurations which provides a
% mapping between delegate attributes and a delegate name.
%
% The format of the LoadDelegateCache method is:
%
% MagickBooleanType LoadDelegateCache(LinkedListInfo *delegate_cache,
% const char *xml,const char *filename,const size_t depth,
% ExceptionInfo *exception)
%
% A description of each parameter follows:
%
% o xml: The delegate list in XML format.
%
% o filename: The delegate list filename.
%
% o depth: depth of statements.
%
% o exception: return any errors or warnings in this structure.
%
*/
static MagickBooleanType LoadDelegateCache(LinkedListInfo *delegate_cache,
const char *xml,const char *filename,const size_t depth,
ExceptionInfo *exception)
{
char
keyword[MagickPathExtent],
*token;
const char
*q;
DelegateInfo
*delegate_info;
MagickStatusType
status;
/*
Load the delegate map file.
*/
(void) LogMagickEvent(ConfigureEvent,GetMagickModule(),
"Loading delegate configuration file \"%s\" ...",filename);
if (xml == (const char *) NULL)
return(MagickFalse);
status=MagickTrue;
delegate_info=(DelegateInfo *) NULL;
token=AcquireString(xml);
for (q=(const char *) xml; *q != '\0'; )
{
/*
Interpret XML.
*/
GetMagickToken(q,&q,token);
if (*token == '\0')
break;
(void) CopyMagickString(keyword,token,MagickPathExtent);
if (LocaleNCompare(keyword,"",2) != 0) && (*q != '\0'))
GetMagickToken(q,&q,token);
continue;
}
if (LocaleNCompare(keyword,"