2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % U U TTTTT IIIII L IIIII TTTTT Y Y %
10 % UUU T IIIII LLLLL IIIII T Y %
13 % MagickCore Utility Methods %
20 % Copyright 1999-2012 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/property.h"
44 #include "MagickCore/blob.h"
45 #include "MagickCore/color.h"
46 #include "MagickCore/exception.h"
47 #include "MagickCore/exception-private.h"
48 #include "MagickCore/geometry.h"
49 #include "MagickCore/list.h"
50 #include "MagickCore/log.h"
51 #include "MagickCore/magick-private.h"
52 #include "MagickCore/memory_.h"
53 #include "MagickCore/nt-base-private.h"
54 #include "MagickCore/option.h"
55 #include "MagickCore/policy.h"
56 #include "MagickCore/resource_.h"
57 #include "MagickCore/semaphore.h"
58 #include "MagickCore/signature-private.h"
59 #include "MagickCore/statistic.h"
60 #include "MagickCore/string_.h"
61 #include "MagickCore/string-private.h"
62 #include "MagickCore/token.h"
63 #include "MagickCore/token-private.h"
64 #include "MagickCore/utility.h"
65 #include "MagickCore/utility-private.h"
66 #if defined(MAGICKCORE_HAVE_PROCESS_H)
69 #if defined(MAGICKCORE_HAVE_MACH_O_DYLD_H)
70 #include <mach-o/dyld.h>
77 Base64[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
83 IsPathDirectory(const char *);
86 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
90 % A c q u i r e U n i q u e F i l e n a m e %
94 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
96 % AcquireUniqueFilename() replaces the contents of path by a unique path name.
98 % The format of the AcquireUniqueFilename method is:
100 % MagickBooleanType AcquireUniqueFilename(char *path)
102 % A description of each parameter follows.
104 % o path: Specifies a pointer to an array of characters. The unique path
105 % name is returned in this array.
108 MagickExport MagickBooleanType AcquireUniqueFilename(char *path)
113 file=AcquireUniqueFileResource(path);
121 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
125 % A c q u i r e U n i q u e S ym b o l i c L i n k %
129 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
131 % AcquireUniqueSymbolicLink() creates a unique symbolic link to the specified
132 % source path and returns MagickTrue on success otherwise MagickFalse. If the
133 % symlink() method fails or is not available, a unique file name is generated
134 % and the source file copied to it. When you are finished with the file, use
135 % RelinquishUniqueFilename() to destroy it.
137 % The format of the AcquireUniqueSymbolicLink method is:
139 % MagickBooleanType AcquireUniqueSymbolicLink(const char *source,
142 % A description of each parameter follows.
144 % o source: the source path.
146 % o destination: the destination path.
150 static inline size_t MagickMin(const size_t x,const size_t y)
157 MagickExport MagickBooleanType AcquireUniqueSymbolicLink(const char *source,
177 assert(source != (const char *) NULL);
178 assert(destination != (char *) NULL);
179 #if defined(MAGICKCORE_HAVE_SYMLINK)
180 (void) AcquireUniqueFilename(destination);
181 (void) RelinquishUniqueFileResource(destination);
182 if (*source == *DirectorySeparator)
184 if (symlink(source,destination) == 0)
193 if (getcwd(path,MaxTextExtent) == (char *) NULL)
195 (void) ConcatenateMagickString(path,DirectorySeparator,MaxTextExtent);
196 (void) ConcatenateMagickString(path,source,MaxTextExtent);
197 if (symlink(path,destination) == 0)
201 destination_file=AcquireUniqueFileResource(destination);
202 if (destination_file == -1)
204 source_file=open_utf8(source,O_RDONLY | O_BINARY,0);
205 if (source_file == -1)
207 (void) close(destination_file);
208 (void) RelinquishUniqueFileResource(destination);
211 quantum=(size_t) MagickMaxBufferExtent;
212 if ((fstat(source_file,&attributes) == 0) && (attributes.st_size != 0))
213 quantum=MagickMin((size_t) attributes.st_size,MagickMaxBufferExtent);
214 buffer=(unsigned char *) AcquireQuantumMemory(quantum,sizeof(*buffer));
215 if (buffer == (unsigned char *) NULL)
217 (void) close(source_file);
218 (void) close(destination_file);
219 (void) RelinquishUniqueFileResource(destination);
224 count=(ssize_t) read(source_file,buffer,quantum);
227 length=(size_t) count;
228 count=(ssize_t) write(destination_file,buffer,length);
229 if ((size_t) count != length)
231 (void) close(destination_file);
232 (void) close(source_file);
233 buffer=(unsigned char *) RelinquishMagickMemory(buffer);
234 (void) RelinquishUniqueFileResource(destination);
238 (void) close(destination_file);
239 (void) close(source_file);
240 buffer=(unsigned char *) RelinquishMagickMemory(buffer);
245 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
249 % A p p e n d I m a g e F o r m a t %
253 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
255 % AppendImageFormat() appends the image format type to the filename. If an
256 % extension to the file already exists, it is first removed.
258 % The format of the AppendImageFormat method is:
260 % void AppendImageFormat(const char *format,char *filename)
262 % A description of each parameter follows.
264 % o format: Specifies a pointer to an array of characters. This the
265 % format of the image.
267 % o filename: Specifies a pointer to an array of characters. The unique
268 % file name is returned in this array.
271 MagickExport void AppendImageFormat(const char *format,char *filename)
274 extension[MaxTextExtent],
277 assert(format != (char *) NULL);
278 assert(filename != (char *) NULL);
279 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",filename);
280 if ((*format == '\0') || (*filename == '\0'))
282 if (LocaleCompare(filename,"-") == 0)
285 message[MaxTextExtent];
287 (void) FormatLocaleString(message,MaxTextExtent,"%s:%s",format,filename);
288 (void) CopyMagickString(filename,message,MaxTextExtent);
291 GetPathComponent(filename,ExtensionPath,extension);
292 if ((LocaleCompare(extension,"Z") == 0) ||
293 (LocaleCompare(extension,"bz2") == 0) ||
294 (LocaleCompare(extension,"gz") == 0) ||
295 (LocaleCompare(extension,"wmz") == 0) ||
296 (LocaleCompare(extension,"svgz") == 0))
298 GetPathComponent(filename,RootPath,root);
299 (void) CopyMagickString(filename,root,MaxTextExtent);
300 GetPathComponent(filename,RootPath,root);
301 (void) FormatLocaleString(filename,MaxTextExtent,"%s.%s.%s",root,format,
305 GetPathComponent(filename,RootPath,root);
306 (void) FormatLocaleString(filename,MaxTextExtent,"%s.%s",root,format);
310 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
314 % B a s e 6 4 D e c o d e %
318 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
320 % Base64Decode() decodes Base64-encoded text and returns its binary
321 % equivalent. NULL is returned if the text is not valid Base64 data, or a
322 % memory allocation failure occurs.
324 % The format of the Base64Decode method is:
326 % unsigned char *Base64Decode(const char *source,length_t *length)
328 % A description of each parameter follows:
330 % o source: A pointer to a Base64-encoded string.
332 % o length: the number of bytes decoded.
335 MagickExport unsigned char *Base64Decode(const char *source,size_t *length)
350 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
351 assert(source != (char *) NULL);
352 assert(length != (size_t *) NULL);
354 decode=(unsigned char *) AcquireQuantumMemory(strlen(source)/4+4,
356 if (decode == (unsigned char *) NULL)
357 return((unsigned char *) NULL);
360 for (p=source; *p != '\0'; p++)
362 if (isspace((int) ((unsigned char) *p)) != 0)
367 if (q == (char *) NULL)
369 decode=(unsigned char *) RelinquishMagickMemory(decode);
370 return((unsigned char *) NULL); /* non-Base64 character */
376 decode[i]=(q-Base64) << 2;
382 decode[i++]|=(q-Base64) >> 4;
383 decode[i]=((q-Base64) & 0x0f) << 4;
389 decode[i++]|=(q-Base64) >> 2;
390 decode[i]=((q-Base64) & 0x03) << 6;
396 decode[i++]|=(q-Base64);
403 Verify Base-64 string has proper terminal characters.
409 decode=(unsigned char *) RelinquishMagickMemory(decode);
410 return((unsigned char *) NULL);
422 Unrecognized '=' character.
424 decode=(unsigned char *) RelinquishMagickMemory(decode);
425 return((unsigned char *) NULL);
429 for ( ; *p != '\0'; p++)
430 if (isspace((int) ((unsigned char) *p)) == 0)
434 decode=(unsigned char *) RelinquishMagickMemory(decode);
435 return((unsigned char *) NULL);
441 for ( ; *p != '\0'; p++)
442 if (isspace((int) ((unsigned char) *p)) == 0)
444 decode=(unsigned char *) RelinquishMagickMemory(decode);
445 return((unsigned char *) NULL);
447 if ((int) decode[i] != 0)
449 decode=(unsigned char *) RelinquishMagickMemory(decode);
450 return((unsigned char *) NULL);
460 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
464 % B a s e 6 4 E n c o d e %
468 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
470 % Base64Encode() encodes arbitrary binary data to Base64 encoded format as
471 % described by the "Base64 Content-Transfer-Encoding" section of RFC 2045 and
472 % returns the result as a null-terminated ASCII string. NULL is returned if
473 % a memory allocation failure occurs.
475 % The format of the Base64Encode method is:
477 % char *Base64Encode(const unsigned char *blob,const size_t blob_length,
478 % size_t *encode_length)
480 % A description of each parameter follows:
482 % o blob: A pointer to binary data to encode.
484 % o blob_length: the number of bytes to encode.
486 % o encode_length: The number of bytes encoded.
489 MagickExport char *Base64Encode(const unsigned char *blob,
490 const size_t blob_length,size_t *encode_length)
495 register const unsigned char
504 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
505 assert(blob != (const unsigned char *) NULL);
506 assert(blob_length != 0);
507 assert(encode_length != (size_t *) NULL);
509 encode=(char *) AcquireQuantumMemory(blob_length/3+4,4*sizeof(*encode));
510 if (encode == (char *) NULL)
511 return((char *) NULL);
513 for (p=blob; p < (blob+blob_length-2); p+=3)
515 encode[i++]=Base64[(int) (*p >> 2)];
516 encode[i++]=Base64[(int) (((*p & 0x03) << 4)+(*(p+1) >> 4))];
517 encode[i++]=Base64[(int) (((*(p+1) & 0x0f) << 2)+(*(p+2) >> 6))];
518 encode[i++]=Base64[(int) (*(p+2) & 0x3f)];
520 remainder=blob_length % 3;
532 for (j=0; j < (ssize_t) remainder; j++)
534 encode[i++]=Base64[(int) (code[0] >> 2)];
535 encode[i++]=Base64[(int) (((code[0] & 0x03) << 4)+(code[1] >> 4))];
539 encode[i++]=Base64[(int) (((code[1] & 0x0f) << 2)+(code[2] >> 6))];
548 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
552 % C h o p P a t h C o m p o n e n t s %
556 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
558 % ChopPathComponents() removes the number of specified file components from a
561 % The format of the ChopPathComponents method is:
563 % ChopPathComponents(char *path,size_t components)
565 % A description of each parameter follows:
569 % o components: The number of components to chop.
572 MagickPrivate void ChopPathComponents(char *path,const size_t components)
577 for (i=0; i < (ssize_t) components; i++)
578 GetPathComponent(path,HeadPath,path);
582 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
586 % E x p a n d F i l e n a m e %
590 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
592 % ExpandFilename() expands '~' in a path.
594 % The format of the ExpandFilename function is:
596 % ExpandFilename(char *path)
598 % A description of each parameter follows:
600 % o path: Specifies a pointer to a character array that contains the
604 MagickPrivate void ExpandFilename(char *path)
607 expand_path[MaxTextExtent];
609 if (path == (char *) NULL)
613 (void) CopyMagickString(expand_path,path,MaxTextExtent);
614 if ((*(path+1) == *DirectorySeparator) || (*(path+1) == '\0'))
620 Substitute ~ with $HOME.
622 (void) CopyMagickString(expand_path,".",MaxTextExtent);
623 (void) ConcatenateMagickString(expand_path,path+1,MaxTextExtent);
624 home=GetEnvironmentValue("HOME");
625 if (home == (char *) NULL)
626 home=GetEnvironmentValue("USERPROFILE");
627 if (home != (char *) NULL)
629 (void) CopyMagickString(expand_path,home,MaxTextExtent);
630 (void) ConcatenateMagickString(expand_path,path+1,MaxTextExtent);
631 home=DestroyString(home);
636 #if defined(MAGICKCORE_POSIX_SUPPORT) && !defined(__OS2__)
638 username[MaxTextExtent];
647 Substitute ~ with home directory from password file.
649 (void) CopyMagickString(username,path+1,MaxTextExtent);
650 p=strchr(username,'/');
651 if (p != (char *) NULL)
653 entry=getpwnam(username);
654 if (entry == (struct passwd *) NULL)
656 (void) CopyMagickString(expand_path,entry->pw_dir,MaxTextExtent);
657 if (p != (char *) NULL)
659 (void) ConcatenateMagickString(expand_path,"/",MaxTextExtent);
660 (void) ConcatenateMagickString(expand_path,p+1,MaxTextExtent);
664 (void) CopyMagickString(path,expand_path,MaxTextExtent);
668 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
672 % E x p a n d F i l e n a m e s %
676 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
678 % ExpandFilenames() checks each argument of the command line vector and
679 % expands it if they have a wildcard character. For example, *.jpg might
680 % expand to: bird.jpg rose.jpg tiki.jpg.
682 % The format of the ExpandFilenames function is:
684 % status=ExpandFilenames(int *number_arguments,char ***arguments)
686 % A description of each parameter follows:
688 % o number_arguments: Specifies a pointer to an integer describing the
689 % number of elements in the argument vector.
691 % o arguments: Specifies a pointer to a text array containing the command
695 MagickExport MagickBooleanType ExpandFilenames(int *number_arguments,
700 home_directory[MaxTextExtent],
715 Allocate argument vector.
717 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
718 assert(number_arguments != (int *) NULL);
719 assert(arguments != (char ***) NULL);
720 vector=(char **) AcquireQuantumMemory((size_t) (*number_arguments+1),
722 if (vector == (char **) NULL)
723 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
725 Expand any wildcard filenames.
727 *home_directory='\0';
729 for (i=0; i < (ssize_t) *number_arguments; i++)
733 filename[MaxTextExtent],
734 magick[MaxTextExtent],
737 subimage[MaxTextExtent];
742 option=(*arguments)[i];
747 vector[count++]=ConstantString(option);
749 parameters=ParseCommandOption(MagickCommandOptions,MagickFalse,option);
753 Do not expand command option parameters.
755 for (j=0; j < parameters; j++)
758 if (i == (ssize_t) *number_arguments)
760 option=(*arguments)[i];
761 vector[count++]=ConstantString(option);
765 if ((*option == '"') || (*option == '\''))
767 GetPathComponent(option,TailPath,filename);
768 GetPathComponent(option,MagickPath,magick);
769 if ((LocaleCompare(magick,"CAPTION") == 0) ||
770 (LocaleCompare(magick,"LABEL") == 0) ||
771 (LocaleCompare(magick,"VID") == 0))
773 if ((IsGlob(filename) == MagickFalse) && (*filename != '@'))
775 if (*filename != '@')
778 Generate file list from wildcard filename (e.g. *.jpg).
780 GetPathComponent(option,HeadPath,path);
781 GetPathComponent(option,SubimagePath,subimage);
782 ExpandFilename(path);
783 if (*home_directory == '\0')
784 directory=getcwd(home_directory,MaxTextExtent-1);
786 filelist=ListFiles(*path == '\0' ? home_directory : path,filename,
801 Generate file list from file list (e.g. @filelist.txt).
803 exception=AcquireExceptionInfo();
804 files=FileToString(filename+1,~0,exception);
805 exception=DestroyExceptionInfo(exception);
806 if (files == (char *) NULL)
808 filelist=StringToArgv(files,&length);
809 if (filelist == (char **) NULL)
811 files=DestroyString(files);
812 filelist[0]=DestroyString(filelist[0]);
813 for (j=0; j < (ssize_t) (length-1); j++)
814 filelist[j]=filelist[j+1];
815 number_files=(size_t) length-1;
817 if (filelist == (char **) NULL)
819 for (j=0; j < (ssize_t) number_files; j++)
820 if (IsPathDirectory(filelist[j]) <= 0)
822 if (j == (ssize_t) number_files)
824 for (j=0; j < (ssize_t) number_files; j++)
825 filelist[j]=DestroyString(filelist[j]);
826 filelist=(char **) RelinquishMagickMemory(filelist);
830 Transfer file list to argument vector.
832 vector=(char **) ResizeQuantumMemory(vector,(size_t) *number_arguments+
833 count+number_files+1,sizeof(*vector));
834 if (vector == (char **) NULL)
836 for (j=0; j < (ssize_t) number_files; j++)
839 parameters=ParseCommandOption(MagickCommandOptions,MagickFalse,option);
846 Do not expand command option parameters.
848 vector[count++]=ConstantString(option);
849 for (k=0; k < parameters; k++)
852 if (j == (ssize_t) number_files)
855 vector[count++]=ConstantString(option);
859 (void) CopyMagickString(filename,path,MaxTextExtent);
861 (void) ConcatenateMagickString(filename,DirectorySeparator,
863 (void) ConcatenateMagickString(filename,filelist[j],MaxTextExtent);
864 filelist[j]=DestroyString(filelist[j]);
865 if (strlen(filename) >= (MaxTextExtent-1))
866 ThrowFatalException(OptionFatalError,"FilenameTruncated");
867 if (IsPathDirectory(filename) <= 0)
875 (void) ConcatenateMagickString(path,magick,MaxTextExtent);
876 (void) ConcatenateMagickString(path,":",MaxTextExtent);
878 (void) ConcatenateMagickString(path,filename,MaxTextExtent);
879 if (*subimage != '\0')
881 (void) ConcatenateMagickString(path,"[",MaxTextExtent);
882 (void) ConcatenateMagickString(path,subimage,MaxTextExtent);
883 (void) ConcatenateMagickString(path,"]",MaxTextExtent);
885 if (strlen(path) >= (MaxTextExtent-1))
886 ThrowFatalException(OptionFatalError,"FilenameTruncated");
887 if (destroy != MagickFalse)
890 vector[count]=DestroyString(vector[count]);
893 vector[count++]=ConstantString(path);
896 filelist=(char **) RelinquishMagickMemory(filelist);
898 vector[count]=(char *) NULL;
899 if (IsEventLogging() != MagickFalse)
904 command_line=AcquireString(vector[0]);
905 for (i=1; i < count; i++)
907 (void) ConcatenateString(&command_line," {");
908 (void) ConcatenateString(&command_line,vector[i]);
909 (void) ConcatenateString(&command_line,"}");
911 (void) LogMagickEvent(ConfigureEvent,GetMagickModule(),
912 "Command line: %s",command_line);
913 command_line=DestroyString(command_line);
915 *number_arguments=(int) count;
921 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
925 % G e t E x e c u t i o n P a t h %
929 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
931 % GetExecutionPath() returns the pathname of the executable that started
932 % the process. On success MagickTrue is returned, otherwise MagickFalse.
934 % The format of the GetExecutionPath method is:
936 % MagickBooleanType GetExecutionPath(char *path,const size_t extent)
938 % A description of each parameter follows:
940 % o path: the pathname of the executable that started the process.
942 % o extent: the maximum extent of the path.
945 MagickPrivate MagickBooleanType GetExecutionPath(char *path,const size_t extent)
951 directory=getcwd(path,(unsigned long) extent);
953 #if defined(MAGICKCORE_HAVE_GETPID) && defined(MAGICKCORE_HAVE_READLINK) && defined(PATH_MAX)
956 link_path[MaxTextExtent],
957 execution_path[PATH_MAX+1];
962 (void) FormatLocaleString(link_path,MaxTextExtent,"/proc/%.20g/exe",
964 count=readlink(link_path,execution_path,PATH_MAX);
967 (void) FormatLocaleString(link_path,MaxTextExtent,"/proc/%.20g/file",
969 count=readlink(link_path,execution_path,PATH_MAX);
971 if ((count > 0) && (count <= (ssize_t) PATH_MAX))
973 execution_path[count]='\0';
974 (void) CopyMagickString(path,execution_path,extent);
978 #if defined(MAGICKCORE_HAVE__NSGETEXECUTABLEPATH)
981 executable_path[PATH_MAX << 1],
982 execution_path[PATH_MAX+1];
987 length=sizeof(executable_path);
988 if ((_NSGetExecutablePath(executable_path,&length) == 0) &&
989 (realpath(executable_path,execution_path) != (char *) NULL))
990 (void) CopyMagickString(path,execution_path,extent);
993 #if defined(MAGICKCORE_HAVE_GETEXECNAME)
998 execution_path=(const char *) getexecname();
999 if (execution_path != (const char *) NULL)
1001 if (*execution_path != *DirectorySeparator)
1002 (void) ConcatenateMagickString(path,DirectorySeparator,extent);
1003 (void) ConcatenateMagickString(path,execution_path,extent);
1007 #if defined(MAGICKCORE_WINDOWS_SUPPORT)
1008 NTGetExecutionPath(path,extent);
1010 #if defined(__GNU__)
1020 execution_path=(char *) NULL;
1021 program_name=program_invocation_name;
1022 if (*program_invocation_name != '/')
1027 extent=strlen(directory)+strlen(program_name)+2;
1028 program_name=AcquireQuantumMemory(extent,sizeof(*program_name));
1029 if (program_name == (char *) NULL)
1030 program_name=program_invocation_name;
1032 count=FormatLocaleString(program_name,extent,"%s/%s",directory,
1033 program_invocation_name);
1037 execution_path=realpath(program_name,NULL);
1038 if (execution_path != (char *) NULL)
1039 (void) CopyMagickString(path,execution_path,extent);
1041 if (program_name != program_invocation_name)
1042 program_name=(char *) RelinquishMagickMemory(program_name);
1043 execution_path=(char *) RelinquishMagickMemory(execution_path);
1046 return(IsPathAccessible(path));
1050 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1054 % G e t M a g i c k P a g e S i z e %
1058 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1060 % GetMagickPageSize() returns the memory page size.
1062 % The format of the GetMagickPageSize method is:
1064 % ssize_t GetMagickPageSize()
1067 MagickPrivate ssize_t GetMagickPageSize(void)
1074 #if defined(MAGICKCORE_HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)
1075 page_size=(ssize_t) sysconf(_SC_PAGE_SIZE);
1077 #if defined(MAGICKCORE_HAVE_GETPAGESIZE)
1078 page_size=(ssize_t) getpagesize();
1087 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1091 % G e t P a t h A t t r i b u t e s %
1095 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1097 % GetPathAttributes() returns attributes (e.g. size of file) about a path.
1099 % The path of the GetPathAttributes method is:
1101 % MagickBooleanType GetPathAttributes(const char *path,void *attributes)
1103 % A description of each parameter follows.
1105 % o path: the file path.
1107 % o attributes: the path attributes are returned here.
1110 MagickExport MagickBooleanType GetPathAttributes(const char *path,
1116 if (path == (const char *) NULL)
1119 return(MagickFalse);
1121 status=stat_utf8(path,(struct stat *) attributes) == 0 ? MagickTrue :
1127 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1131 % G e t P a t h C o m p o n e n t %
1135 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1137 % GetPathComponent() returns the parent directory name, filename, basename, or
1138 % extension of a file path.
1140 % The format of the GetPathComponent function is:
1142 % GetPathComponent(const char *path,PathType type,char *component)
1144 % A description of each parameter follows:
1146 % o path: Specifies a pointer to a character array that contains the
1149 % o type: Specififies which file path component to return.
1151 % o component: the selected file path component is returned here.
1154 MagickExport void GetPathComponent(const char *path,PathType type,
1158 magick[MaxTextExtent],
1160 subimage[MaxTextExtent];
1165 assert(path != (const char *) NULL);
1166 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",path);
1167 assert(component != (char *) NULL);
1173 (void) CopyMagickString(component,path,MaxTextExtent);
1175 #if defined(__OS2__)
1178 for (p=component; *p != '\0'; p++)
1180 if ((*p == '%') && (*(p+1) == '['))
1185 for (p++; (*p != ']') && (*p != '\0'); p++) ;
1189 if ((*p == ':') && (IsPathDirectory(path) < 0) &&
1190 (IsPathAccessible(path) == MagickFalse))
1193 Look for image format specification (e.g. ps3:image).
1195 (void) CopyMagickString(magick,component,(size_t) (p-component+1));
1196 if (IsMagickConflict(magick) != MagickFalse)
1199 for (q=component; *q != '\0'; q++)
1207 p=component+strlen(component)-1;
1208 if ((*p == ']') && (strchr(component,'[') != (char *) NULL) &&
1209 (IsPathAccessible(path) == MagickFalse))
1212 Look for scene specification (e.g. img0001.pcd[4]).
1214 for (q=p-1; q > component; q--)
1219 (void) CopyMagickString(subimage,q+1,MaxTextExtent);
1220 subimage[p-q-1]='\0';
1221 if ((IsSceneGeometry(subimage,MagickFalse) == MagickFalse) &&
1222 (IsGeometry(subimage) == MagickFalse))
1230 for (p=component+strlen(component)-1; p > component; p--)
1231 if (IsBasenameSeparator(*p) != MagickFalse)
1237 (void) CopyMagickString(component,magick,MaxTextExtent);
1242 for (p=component+(strlen(component)-1); p > component; p--)
1244 if (IsBasenameSeparator(*p) != MagickFalse)
1260 if (IsBasenameSeparator(*p) != MagickFalse)
1261 (void) CopyMagickMemory((unsigned char *) component,
1262 (const unsigned char *) (p+1),strlen(p+1)+1);
1267 if (IsBasenameSeparator(*p) != MagickFalse)
1268 (void) CopyMagickString(component,p+1,MaxTextExtent);
1269 for (p=component+(strlen(component)-1); p > component; p--)
1279 if (IsBasenameSeparator(*p) != MagickFalse)
1280 (void) CopyMagickString(component,p+1,MaxTextExtent);
1283 for (p=component+strlen(component)-1; p > component; p--)
1288 (void) CopyMagickString(component,p+1,MaxTextExtent);
1293 (void) CopyMagickString(component,subimage,MaxTextExtent);
1303 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1307 % G e t P a t h C o m p o n e n t s %
1311 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1313 % GetPathComponents() returns a list of path components.
1315 % The format of the GetPathComponents method is:
1317 % char **GetPathComponents(const char *path,
1318 % size_t *number_componenets)
1320 % A description of each parameter follows:
1322 % o path: Specifies the string to segment into a list.
1324 % o number_components: return the number of components in the list
1327 MagickPrivate char **GetPathComponents(const char *path,
1328 size_t *number_components)
1340 if (path == (char *) NULL)
1341 return((char **) NULL);
1342 *number_components=1;
1343 for (p=path; *p != '\0'; p++)
1344 if (IsBasenameSeparator(*p))
1345 (*number_components)++;
1346 components=(char **) AcquireQuantumMemory((size_t) *number_components+1UL,
1347 sizeof(*components));
1348 if (components == (char **) NULL)
1349 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1351 for (i=0; i < (ssize_t) *number_components; i++)
1353 for (q=p; *q != '\0'; q++)
1354 if (IsBasenameSeparator(*q))
1356 components[i]=(char *) AcquireQuantumMemory((size_t) (q-p)+MaxTextExtent,
1357 sizeof(**components));
1358 if (components[i] == (char *) NULL)
1359 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1360 (void) CopyMagickString(components[i],p,(size_t) (q-p+1));
1363 components[i]=(char *) NULL;
1368 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1372 % I s P a t h A c c e s s i b l e %
1376 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1378 % IsPathAccessible() returns MagickTrue if the file as defined by the path is
1381 % The format of the IsPathAccessible method is:
1383 % MagickBooleanType IsPathAccessible(const char *filename)
1385 % A description of each parameter follows.
1387 % o path: Specifies a path to a file.
1390 MagickExport MagickBooleanType IsPathAccessible(const char *path)
1398 if ((path == (const char *) NULL) || (*path == '\0'))
1399 return(MagickFalse);
1400 status=GetPathAttributes(path,&attributes);
1401 if (status == MagickFalse)
1403 if (S_ISREG(attributes.st_mode) == 0)
1404 return(MagickFalse);
1405 if (access_utf8(path,F_OK) != 0)
1406 return(MagickFalse);
1411 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1415 + I s P a t h D i r e c t o r y %
1419 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1421 % IsPathDirectory() returns -1 if the directory does not exist, 1 is returned
1422 % if the path represents a directory otherwise 0.
1424 % The format of the IsPathDirectory method is:
1426 % int IsPathDirectory(const char *path)
1428 % A description of each parameter follows.
1430 % o path: The directory path.
1433 static int IsPathDirectory(const char *path)
1441 if ((path == (const char *) NULL) || (*path == '\0'))
1442 return(MagickFalse);
1443 status=GetPathAttributes(path,&attributes);
1444 if (status == MagickFalse)
1446 if (S_ISDIR(attributes.st_mode) == 0)
1452 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1456 % I s M a g i c k T r u e %
1460 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1462 % IsMagickTrue() returns MagickTrue if the value is "true", "on", "yes" or
1465 % The format of the IsMagickTrue method is:
1467 % MagickBooleanType IsMagickTrue(const char *value)
1469 % A description of each parameter follows:
1471 % o option: either MagickTrue or MagickFalse depending on the value
1474 % o value: Specifies a pointer to a character array.
1477 MagickExport MagickBooleanType IsMagickTrue(const char *value)
1479 if (value == (const char *) NULL)
1480 return(MagickFalse);
1481 if (LocaleCompare(value,"true") == 0)
1483 if (LocaleCompare(value,"on") == 0)
1485 if (LocaleCompare(value,"yes") == 0)
1487 if (LocaleCompare(value,"1") == 0)
1489 return(MagickFalse);
1493 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1497 % L i s t F i l e s %
1501 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1503 % ListFiles() reads the directory specified and returns a list of filenames
1504 % contained in the directory sorted in ascending alphabetic order.
1506 % The format of the ListFiles function is:
1508 % char **ListFiles(const char *directory,const char *pattern,
1509 % ssize_t *number_entries)
1511 % A description of each parameter follows:
1513 % o filelist: Method ListFiles returns a list of filenames contained
1514 % in the directory. If the directory specified cannot be read or it is
1515 % a file a NULL list is returned.
1517 % o directory: Specifies a pointer to a text string containing a directory
1520 % o pattern: Specifies a pointer to a text string containing a pattern.
1522 % o number_entries: This integer returns the number of filenames in the
1527 #if defined(__cplusplus) || defined(c_plusplus)
1531 static int FileCompare(const void *x,const void *y)
1537 p=(const char **) x;
1538 q=(const char **) y;
1539 return(LocaleCompare(*p,*q));
1542 #if defined(__cplusplus) || defined(c_plusplus)
1546 static inline int MagickReadDirectory(DIR *directory,struct dirent *entry,
1547 struct dirent **result)
1549 #if defined(MAGICKCORE_HAVE_READDIR_R)
1550 return(readdir_r(directory,entry,result));
1554 *result=readdir(directory);
1559 MagickPrivate char **ListFiles(const char *directory,const char *pattern,
1560 size_t *number_entries)
1578 assert(directory != (const char *) NULL);
1579 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",directory);
1580 assert(pattern != (const char *) NULL);
1581 assert(number_entries != (size_t *) NULL);
1583 current_directory=opendir(directory);
1584 if (current_directory == (DIR *) NULL)
1585 return((char **) NULL);
1590 filelist=(char **) AcquireQuantumMemory((size_t) max_entries,
1592 if (filelist == (char **) NULL)
1594 (void) closedir(current_directory);
1595 return((char **) NULL);
1598 Save the current and change to the new directory.
1600 buffer=(struct dirent *) AcquireMagickMemory(sizeof(*buffer)+
1602 if (buffer == (struct dirent *) NULL)
1603 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1604 while ((MagickReadDirectory(current_directory,buffer,&entry) == 0) &&
1605 (entry != (struct dirent *) NULL))
1607 if (*entry->d_name == '.')
1609 if ((IsPathDirectory(entry->d_name) > 0) ||
1610 #if defined(MAGICKCORE_WINDOWS_SUPPORT)
1611 (GlobExpression(entry->d_name,pattern,MagickTrue) != MagickFalse))
1613 (GlobExpression(entry->d_name,pattern,MagickFalse) != MagickFalse))
1616 if (*number_entries >= max_entries)
1619 Extend the file list.
1622 filelist=(char **) ResizeQuantumMemory(filelist,(size_t)
1623 max_entries,sizeof(*filelist));
1624 if (filelist == (char **) NULL)
1632 p=strchr(entry->d_name,';');
1635 if (*number_entries > 0)
1636 if (LocaleCompare(entry->d_name,filelist[*number_entries-1]) == 0)
1640 filelist[*number_entries]=(char *) AcquireString(entry->d_name);
1641 (*number_entries)++;
1644 buffer=(struct dirent *) RelinquishMagickMemory(buffer);
1645 (void) closedir(current_directory);
1646 if (filelist == (char **) NULL)
1647 return((char **) NULL);
1649 Sort filelist in ascending order.
1651 qsort((void *) filelist,(size_t) *number_entries,sizeof(*filelist),
1657 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1661 % M a g i c k D e l a y %
1665 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1667 % MagickDelay() suspends program execution for the number of milliseconds
1670 % The format of the Delay method is:
1672 % void MagickDelay(const MagickSizeType milliseconds)
1674 % A description of each parameter follows:
1676 % o milliseconds: Specifies the number of milliseconds to delay before
1680 MagickPrivate void MagickDelay(const MagickSizeType milliseconds)
1682 if (milliseconds == 0)
1684 #if defined(MAGICKCORE_HAVE_NANOSLEEP)
1689 timer.tv_sec=(time_t) (milliseconds/1000);
1690 timer.tv_nsec=(milliseconds % 1000)*1000*1000;
1691 (void) nanosleep(&timer,(struct timespec *) NULL);
1693 #elif defined(MAGICKCORE_HAVE_USLEEP)
1694 usleep(1000*milliseconds);
1695 #elif defined(MAGICKCORE_HAVE_SELECT)
1700 timer.tv_sec=(long) milliseconds/1000;
1701 timer.tv_usec=(long) (milliseconds % 1000)*1000;
1702 (void) select(0,(XFD_SET *) NULL,(XFD_SET *) NULL,(XFD_SET *) NULL,&timer);
1704 #elif defined(MAGICKCORE_HAVE_POLL)
1705 (void) poll((struct pollfd *) NULL,0,(int) milliseconds);
1706 #elif defined(MAGICKCORE_WINDOWS_SUPPORT)
1707 Sleep((long) milliseconds);
1713 timer=milliseconds/1000.0;
1716 #elif defined(__BEOS__)
1717 snooze(1000*milliseconds);
1719 # error "Time delay method not defined."
1724 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1728 % M u l t i l i n e C e n s u s %
1732 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1734 % MultilineCensus() returns the number of lines within a label. A line is
1735 % represented by a \n character.
1737 % The format of the MultilineCenus method is:
1739 % size_t MultilineCensus(const char *label)
1741 % A description of each parameter follows.
1743 % o label: This character string is the label.
1746 MagickExport size_t MultilineCensus(const char *label)
1752 Determine the number of lines within this label.
1754 if (label == (char *) NULL)
1756 for (number_lines=1; *label != '\0'; label++)
1759 return(number_lines);
1763 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1767 % S y s t e m C o m m a n d %
1771 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1773 % SystemCommand() executes the specified command and waits until it
1774 % terminates. The returned value is the exit status of the command.
1776 % The format of the SystemCommand method is:
1778 % int SystemCommand(const MagickBooleanType asynchronous,
1779 % const MagickBooleanType verbose,const char *command,
1780 % ExceptionInfo *exception)
1782 % A description of each parameter follows:
1784 % o asynchronous: a value other than 0 executes the parent program
1785 % concurrently with the new child process.
1787 % o verbose: a value other than 0 prints the executed command before it is
1790 % o command: this string is the command to execute.
1792 % o exception: return any errors here.
1795 MagickExport int SystemCommand(const MagickBooleanType asynchronous,
1796 const MagickBooleanType verbose,const char *command,ExceptionInfo *exception)
1816 arguments=StringToArgv(command,&number_arguments);
1817 if (arguments == (char **) NULL)
1819 rights=ExecutePolicyRights;
1820 domain=DelegatePolicyDomain;
1821 if (IsRightsAuthorized(domain,rights,arguments[1]) == MagickFalse)
1824 (void) ThrowMagickException(exception,GetMagickModule(),PolicyError,
1825 "NotAuthorized","`%s'",arguments[1]);
1826 for (i=0; i < (ssize_t) number_arguments; i++)
1827 arguments[i]=DestroyString(arguments[i]);
1828 arguments=(char **) RelinquishMagickMemory(arguments);
1831 if (verbose != MagickFalse)
1833 (void) FormatLocaleFile(stderr,"%s\n",command);
1834 (void) fflush(stderr);
1836 shell_command=(char *) command;
1837 if (asynchronous != MagickFalse)
1839 shell_command=AcquireString(command);
1840 (void) ConcatenateMagickString(shell_command,"&",MaxTextExtent);
1842 #if defined(MAGICKCORE_POSIX_SUPPORT)
1843 #if !defined(MAGICKCORE_HAVE_EXECVP)
1844 status=system(shell_command);
1846 if ((asynchronous != MagickFalse) || (strspn(shell_command,"&;<>|") == 0))
1847 status=system(shell_command);
1854 Call application directly rather than from a shell.
1857 if (child_pid == (pid_t) -1)
1858 status=system(command);
1862 status=execvp(arguments[1],arguments+1);
1874 pid=waitpid(child_pid,&child_status,0);
1879 if (WIFEXITED(child_status) != 0)
1880 status=WEXITSTATUS(child_status);
1882 if (WIFSIGNALED(child_status))
1888 #elif defined(MAGICKCORE_WINDOWS_SUPPORT)
1889 status=NTSystemCommand(shell_command);
1890 #elif defined(macintosh)
1891 status=MACSystemCommand(shell_command);
1893 status=system(shell_command);
1895 # error No suitable system() method.
1898 (void) ThrowMagickException(exception,GetMagickModule(),DelegateError,
1899 "`%s' (%d)",command,status);
1900 if (shell_command != command)
1901 shell_command=DestroyString(shell_command);
1902 for (i=0; i < (ssize_t) number_arguments; i++)
1903 arguments[i]=DestroyString(arguments[i]);
1904 arguments=(char **) RelinquishMagickMemory(arguments);