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-2010 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 "magick/studio.h"
43 #include "magick/property.h"
44 #include "magick/blob.h"
45 #include "magick/color.h"
46 #include "magick/exception.h"
47 #include "magick/exception-private.h"
48 #include "magick/geometry.h"
49 #include "magick/list.h"
50 #include "magick/log.h"
51 #include "magick/memory_.h"
52 #include "magick/option.h"
53 #include "magick/policy.h"
54 #include "magick/resource_.h"
55 #include "magick/semaphore.h"
56 #include "magick/signature-private.h"
57 #include "magick/statistic.h"
58 #include "magick/string_.h"
59 #include "magick/token.h"
60 #include "magick/utility.h"
61 #if defined(MAGICKCORE_HAVE_PROCESS_H)
64 #if defined(MAGICKCORE_HAVE_MACH_O_DYLD_H)
65 #include <mach-o/dyld.h>
72 Base64[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
78 IsPathDirectory(const char *);
81 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
85 % A c q u i r e U n i q u e F i l e n a m e %
89 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
91 % AcquireUniqueFilename() replaces the contents of path by a unique path name.
93 % The format of the AcquireUniqueFilename method is:
95 % MagickBooleanType AcquireUniqueFilename(char *path)
97 % A description of each parameter follows.
99 % o path: Specifies a pointer to an array of characters. The unique path
100 % name is returned in this array.
103 MagickExport MagickBooleanType AcquireUniqueFilename(char *path)
108 file=AcquireUniqueFileResource(path);
116 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
120 % A c q u i r e U n i q u e S ym b o l i c L i n k %
124 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
126 % AcquireUniqueSymbolicLink() creates a unique symbolic link to the specified
127 % source path and returns MagickTrue on success otherwise MagickFalse. If the
128 % symlink() method fails or is not available, a unique file name is generated
129 % and the source file copied to it. When you are finished with the file, use
130 % RelinquishUniqueFilename() to destroy it.
132 % The format of the AcquireUniqueSymbolicLink method is:
134 % MagickBooleanType AcquireUniqueSymbolicLink(const char *source,
137 % A description of each parameter follows.
139 % o source: the source path.
141 % o destination: the destination path.
145 static inline size_t MagickMin(const size_t x,const size_t y)
152 MagickExport MagickBooleanType AcquireUniqueSymbolicLink(const char *source,
172 assert(source != (const char *) NULL);
173 assert(destination != (char *) NULL);
174 #if defined(MAGICKCORE_HAVE_SYMLINK)
175 (void) AcquireUniqueFilename(destination);
176 (void) RelinquishUniqueFileResource(destination);
177 if (*source == *DirectorySeparator)
179 if (symlink(source,destination) == 0)
188 if (getcwd(path,MaxTextExtent) == (char *) NULL)
190 (void) ConcatenateMagickString(path,DirectorySeparator,MaxTextExtent);
191 (void) ConcatenateMagickString(path,source,MaxTextExtent);
192 if (symlink(path,destination) == 0)
196 destination_file=AcquireUniqueFileResource(destination);
197 if (destination_file == -1)
199 source_file=open(source,O_RDONLY | O_BINARY);
200 if (source_file == -1)
202 (void) close(destination_file);
203 (void) RelinquishUniqueFileResource(destination);
206 quantum=(size_t) MagickMaxBufferExtent;
207 if ((fstat(source_file,&attributes) == 0) && (attributes.st_size != 0))
208 quantum=MagickMin((size_t) attributes.st_size,MagickMaxBufferExtent);
209 buffer=(unsigned char *) AcquireQuantumMemory(quantum,sizeof(*buffer));
210 if (buffer == (unsigned char *) NULL)
212 (void) close(source_file);
213 (void) close(destination_file);
214 (void) RelinquishUniqueFileResource(destination);
219 count=(ssize_t) read(source_file,buffer,quantum);
222 length=(size_t) count;
223 count=(ssize_t) write(destination_file,buffer,length);
224 if ((size_t) count != length)
226 (void) close(destination_file);
227 (void) close(source_file);
228 buffer=(unsigned char *) RelinquishMagickMemory(buffer);
229 (void) RelinquishUniqueFileResource(destination);
233 (void) close(destination_file);
234 (void) close(source_file);
235 buffer=(unsigned char *) RelinquishMagickMemory(buffer);
240 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
244 % A p p e n d I m a g e F o r m a t %
248 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
250 % AppendImageFormat() appends the image format type to the filename. If an
251 % extension to the file already exists, it is first removed.
253 % The format of the AppendImageFormat method is:
255 % void AppendImageFormat(const char *format,char *filename)
257 % A description of each parameter follows.
259 % o format: Specifies a pointer to an array of characters. This the
260 % format of the image.
262 % o filename: Specifies a pointer to an array of characters. The unique
263 % file name is returned in this array.
266 MagickExport void AppendImageFormat(const char *format,char *filename)
271 assert(format != (char *) NULL);
272 assert(filename != (char *) NULL);
273 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",filename);
274 if ((*format == '\0') || (*filename == '\0'))
276 if (LocaleCompare(filename,"-") == 0)
279 message[MaxTextExtent];
281 (void) FormatMagickString(message,MaxTextExtent,"%s:%s",format,filename);
282 (void) CopyMagickString(filename,message,MaxTextExtent);
285 GetPathComponent(filename,RootPath,root);
286 (void) FormatMagickString(filename,MaxTextExtent,"%s.%s",root,format);
290 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
294 % B a s e 6 4 D e c o d e %
298 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
300 % Base64Decode() decodes Base64-encoded text and returns its binary
301 % equivalent. NULL is returned if the text is not valid Base64 data, or a
302 % memory allocation failure occurs.
304 % The format of the Base64Decode method is:
306 % unsigned char *Base64Decode(const char *source,length_t *length)
308 % A description of each parameter follows:
310 % o source: A pointer to a Base64-encoded string.
312 % o length: the number of bytes decoded.
315 MagickExport unsigned char *Base64Decode(const char *source,size_t *length)
330 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
331 assert(source != (char *) NULL);
332 assert(length != (size_t *) NULL);
334 decode=(unsigned char *) AcquireQuantumMemory(strlen(source)/4+4,
336 if (decode == (unsigned char *) NULL)
337 return((unsigned char *) NULL);
340 for (p=source; *p != '\0'; p++)
342 if (isspace((int) ((unsigned char) *p)) != 0)
347 if (q == (char *) NULL)
349 decode=(unsigned char *) RelinquishMagickMemory(decode);
350 return((unsigned char *) NULL); /* non-Base64 character */
356 decode[i]=(q-Base64) << 2;
362 decode[i++]|=(q-Base64) >> 4;
363 decode[i]=((q-Base64) & 0x0f) << 4;
369 decode[i++]|=(q-Base64) >> 2;
370 decode[i]=((q-Base64) & 0x03) << 6;
376 decode[i++]|=(q-Base64);
383 Verify Base-64 string has proper terminal characters.
389 decode=(unsigned char *) RelinquishMagickMemory(decode);
390 return((unsigned char *) NULL);
402 Unrecognized '=' character.
404 decode=(unsigned char *) RelinquishMagickMemory(decode);
405 return((unsigned char *) NULL);
409 for ( ; *p != '\0'; p++)
410 if (isspace((int) ((unsigned char) *p)) == 0)
414 decode=(unsigned char *) RelinquishMagickMemory(decode);
415 return((unsigned char *) NULL);
421 for ( ; *p != '\0'; p++)
422 if (isspace((int) ((unsigned char) *p)) == 0)
424 decode=(unsigned char *) RelinquishMagickMemory(decode);
425 return((unsigned char *) NULL);
427 if ((int) decode[i] != 0)
429 decode=(unsigned char *) RelinquishMagickMemory(decode);
430 return((unsigned char *) NULL);
440 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
444 % B a s e 6 4 E n c o d e %
448 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
450 % Base64Encode() encodes arbitrary binary data to Base64 encoded format as
451 % described by the "Base64 Content-Transfer-Encoding" section of RFC 2045 and
452 % returns the result as a null-terminated ASCII string. NULL is returned if
453 % a memory allocation failure occurs.
455 % The format of the Base64Encode method is:
457 % char *Base64Encode(const unsigned char *blob,const size_t blob_length,
458 % size_t *encode_length)
460 % A description of each parameter follows:
462 % o blob: A pointer to binary data to encode.
464 % o blob_length: the number of bytes to encode.
466 % o encode_length: The number of bytes encoded.
469 MagickExport char *Base64Encode(const unsigned char *blob,
470 const size_t blob_length,size_t *encode_length)
475 register const unsigned char
484 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
485 assert(blob != (const unsigned char *) NULL);
486 assert(blob_length != 0);
487 assert(encode_length != (size_t *) NULL);
489 encode=(char *) AcquireQuantumMemory(blob_length/3+4,4*sizeof(*encode));
490 if (encode == (char *) NULL)
491 return((char *) NULL);
493 for (p=blob; p < (blob+blob_length-2); p+=3)
495 encode[i++]=Base64[(int) (*p >> 2)];
496 encode[i++]=Base64[(int) (((*p & 0x03) << 4)+(*(p+1) >> 4))];
497 encode[i++]=Base64[(int) (((*(p+1) & 0x0f) << 2)+(*(p+2) >> 6))];
498 encode[i++]=Base64[(int) (*(p+2) & 0x3f)];
500 remainder=blob_length % 3;
512 for (j=0; j < (long) remainder; j++)
514 encode[i++]=Base64[(int) (code[0] >> 2)];
515 encode[i++]=Base64[(int) (((code[0] & 0x03) << 4)+(code[1] >> 4))];
519 encode[i++]=Base64[(int) (((code[1] & 0x0f) << 2)+(code[2] >> 6))];
528 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
532 % C h o p P a t h C o m p o n e n t s %
536 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
538 % ChopPathComponents() removes the number of specified file components from a
541 % The format of the ChopPathComponents method is:
543 % ChopPathComponents(char *path,unsigned long components)
545 % A description of each parameter follows:
549 % o components: The number of components to chop.
552 MagickExport void ChopPathComponents(char *path,const unsigned long components)
557 for (i=0; i < (long) components; i++)
558 GetPathComponent(path,HeadPath,path);
562 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
566 % E x p a n d F i l e n a m e %
570 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
572 % ExpandFilename() expands '~' in a path.
574 % The format of the ExpandFilename function is:
576 % ExpandFilename(char *path)
578 % A description of each parameter follows:
580 % o path: Specifies a pointer to a character array that contains the
584 MagickExport void ExpandFilename(char *path)
587 expand_path[MaxTextExtent];
589 if (path == (char *) NULL)
593 (void) CopyMagickString(expand_path,path,MaxTextExtent);
594 if ((*(path+1) == *DirectorySeparator) || (*(path+1) == '\0'))
600 Substitute ~ with $HOME.
602 (void) CopyMagickString(expand_path,".",MaxTextExtent);
603 (void) ConcatenateMagickString(expand_path,path+1,MaxTextExtent);
604 home=GetEnvironmentValue("HOME");
605 if (home == (char *) NULL)
606 home=GetEnvironmentValue("USERPROFILE");
607 if (home != (char *) NULL)
609 (void) CopyMagickString(expand_path,home,MaxTextExtent);
610 (void) ConcatenateMagickString(expand_path,path+1,MaxTextExtent);
611 home=DestroyString(home);
616 #if defined(MAGICKCORE_POSIX_SUPPORT) && !defined(__OS2__)
618 username[MaxTextExtent];
627 Substitute ~ with home directory from password file.
629 (void) CopyMagickString(username,path+1,MaxTextExtent);
630 p=strchr(username,'/');
631 if (p != (char *) NULL)
633 entry=getpwnam(username);
634 if (entry == (struct passwd *) NULL)
636 (void) CopyMagickString(expand_path,entry->pw_dir,MaxTextExtent);
637 if (p != (char *) NULL)
639 (void) ConcatenateMagickString(expand_path,"/",MaxTextExtent);
640 (void) ConcatenateMagickString(expand_path,p+1,MaxTextExtent);
644 (void) CopyMagickString(path,expand_path,MaxTextExtent);
648 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
652 % E x p a n d F i l e n a m e s %
656 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
658 % ExpandFilenames() checks each argument of the command line vector and
659 % expands it if they have a wildcard character. For example, *.jpg might
660 % expand to: bird.jpg rose.jpg tiki.jpg.
662 % The format of the ExpandFilenames function is:
664 % status=ExpandFilenames(int *number_arguments,char ***arguments)
666 % A description of each parameter follows:
668 % o number_arguments: Specifies a pointer to an integer describing the
669 % number of elements in the argument vector.
671 % o arguments: Specifies a pointer to a text array containing the command
675 MagickExport MagickBooleanType ExpandFilenames(int *number_arguments,
680 home_directory[MaxTextExtent],
695 Allocate argument vector.
697 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
698 assert(number_arguments != (int *) NULL);
699 assert(arguments != (char ***) NULL);
700 vector=(char **) AcquireQuantumMemory((size_t) (*number_arguments+1),
702 if (vector == (char **) NULL)
703 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
705 Expand any wildcard filenames.
707 *home_directory='\0';
709 for (i=0; i < (long) *number_arguments; i++)
713 filename[MaxTextExtent],
714 magick[MaxTextExtent],
717 subimage[MaxTextExtent];
722 option=(*arguments)[i];
727 vector[count++]=ConstantString(option);
729 parameters=ParseMagickOption(MagickCommandOptions,MagickFalse,option);
733 Do not expand command option parameters.
735 for (j=0; j < parameters; j++)
738 if (i == (long) *number_arguments)
740 option=(*arguments)[i];
741 vector[count++]=ConstantString(option);
745 if ((*option == '"') || (*option == '\''))
747 GetPathComponent(option,TailPath,filename);
748 GetPathComponent(option,MagickPath,magick);
749 if ((LocaleCompare(magick,"CAPTION") == 0) ||
750 (LocaleCompare(magick,"LABEL") == 0) ||
751 (LocaleCompare(magick,"VID") == 0))
753 if ((IsGlob(filename) == MagickFalse) && (*filename != '@'))
755 if (*filename != '@')
758 Generate file list from wildcard filename (e.g. *.jpg).
760 GetPathComponent(option,HeadPath,path);
761 GetPathComponent(option,SubimagePath,subimage);
762 ExpandFilename(path);
763 if (*home_directory == '\0')
764 cwd=getcwd(home_directory,MaxTextExtent-1);
765 filelist=ListFiles(*path == '\0' ? home_directory : path,filename,
780 Generate file list from file list (e.g. @filelist.txt).
782 exception=AcquireExceptionInfo();
783 files=FileToString(filename+1,~0,exception);
784 exception=DestroyExceptionInfo(exception);
785 if (files == (char *) NULL)
788 filelist=StringToArgv(files,&number_images);
789 files=DestroyString(files);
790 number_files=(unsigned long) number_images;
791 if (filelist != (char **) NULL)
794 for (j=0; j < (long) number_files; j++)
795 filelist[j]=filelist[j+1];
798 if (filelist == (char **) NULL)
800 for (j=0; j < (long) number_files; j++)
801 if (IsPathDirectory(filelist[j]) <= 0)
803 if (j == (long) number_files)
805 for (j=0; j < (long) number_files; j++)
806 filelist[j]=DestroyString(filelist[j]);
807 filelist=(char **) RelinquishMagickMemory(filelist);
811 Transfer file list to argument vector.
813 vector=(char **) ResizeQuantumMemory(vector,(size_t) *number_arguments+
814 count+number_files+1,sizeof(*vector));
815 if (vector == (char **) NULL)
817 for (j=0; j < (long) number_files; j++)
819 (void) CopyMagickString(filename,path,MaxTextExtent);
821 (void) ConcatenateMagickString(filename,DirectorySeparator,
823 (void) ConcatenateMagickString(filename,filelist[j],MaxTextExtent);
824 filelist[j]=DestroyString(filelist[j]);
825 if (strlen(filename) >= MaxTextExtent)
826 ThrowFatalException(OptionFatalError,"FilenameTruncated");
827 if (IsPathDirectory(filename) <= 0)
835 (void) ConcatenateMagickString(path,magick,MaxTextExtent);
836 (void) ConcatenateMagickString(path,":",MaxTextExtent);
838 (void) ConcatenateMagickString(path,filename,MaxTextExtent);
839 if (*subimage != '\0')
841 (void) ConcatenateMagickString(path,"[",MaxTextExtent);
842 (void) ConcatenateMagickString(path,subimage,MaxTextExtent);
843 (void) ConcatenateMagickString(path,"]",MaxTextExtent);
845 if (strlen(path) >= MaxTextExtent)
846 ThrowFatalException(OptionFatalError,"FilenameTruncated");
847 if (destroy != MagickFalse)
850 vector[count]=DestroyString(vector[count]);
853 vector[count++]=ConstantString(path);
856 filelist=(char **) RelinquishMagickMemory(filelist);
858 vector[count]=(char *) NULL;
859 if (IsEventLogging() != MagickFalse)
864 command_line=AcquireString(vector[0]);
865 for (i=1; i < count; i++)
867 (void) ConcatenateString(&command_line," {");
868 (void) ConcatenateString(&command_line,vector[i]);
869 (void) ConcatenateString(&command_line,"}");
871 (void) LogMagickEvent(ConfigureEvent,GetMagickModule(),
872 "Command line: %s",command_line);
873 command_line=DestroyString(command_line);
875 *number_arguments=(int) count;
881 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
885 % G e t E x e c u t i o n P a t h %
889 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
891 % GetExecutionPath() returns the pathname of the executable that started
892 % the process. On success MagickTrue is returned, otherwise MagickFalse.
894 % The format of the GetExecutionPath method is:
896 % MagickBooleanType GetExecutionPath(char *path,const size_t extent)
898 % A description of each parameter follows:
900 % o path: the pathname of the executable that started the process.
902 % o extent: the maximum extent of the path.
905 MagickExport MagickBooleanType GetExecutionPath(char *path,const size_t extent)
911 cwd=getcwd(path,(unsigned long) extent);
912 #if defined(MAGICKCORE_HAVE_GETPID) && defined(MAGICKCORE_HAVE_READLINK) && defined(PATH_MAX)
915 link_path[MaxTextExtent],
916 execution_path[PATH_MAX+1];
921 (void) FormatMagickString(link_path,MaxTextExtent,"/proc/%ld/exe",
923 count=readlink(link_path,execution_path,PATH_MAX);
926 (void) FormatMagickString(link_path,MaxTextExtent,"/proc/%ld/file",
928 count=readlink(link_path,execution_path,PATH_MAX);
930 if ((count > 0) && (count <= (ssize_t) PATH_MAX))
932 execution_path[count]='\0';
933 (void) CopyMagickString(path,execution_path,extent);
937 #if defined(MAGICKCORE_HAVE__NSGETEXECUTABLEPATH)
940 executable_path[PATH_MAX << 1],
941 execution_path[PATH_MAX+1];
946 length=sizeof(executable_path);
947 if ((_NSGetExecutablePath(executable_path,&length) == 0) &&
948 (realpath(executable_path,execution_path) != (char *) NULL))
949 (void) CopyMagickString(path,execution_path,extent);
952 #if defined(MAGICKCORE_HAVE_GETEXECNAME)
957 execution_path=(const char *) getexecname();
958 if (execution_path != (const char *) NULL)
960 if (*execution_path != *DirectorySeparator)
961 (void) ConcatenateMagickString(path,DirectorySeparator,extent);
962 (void) ConcatenateMagickString(path,execution_path,extent);
966 #if defined(MAGICKCORE_WINDOWS_SUPPORT)
967 NTGetExecutionPath(path,extent);
979 execution_path=(char *) NULL;
980 program_name=program_invocation_name;
981 if (*program_invocation_name != '/')
986 extent=strlen(cwd)+strlen(program_name)+1;
987 program_name=AcquireQuantumMemory(extent,sizeof(*program_name));
988 if (program_name == (char *) NULL)
989 program_name=program_invocation_name;
991 count=FormatMagickString(program_name,extent,"%s/%s",cwd,
992 program_invocation_name);
996 execution_path=realpath(program_name,NULL);
997 if (execution_path != (char *) NULL)
998 (void) CopyMagickString(path,execution_path,extent);
1000 if (program_name != program_invocation_name)
1001 program_name=(char *) RelinquishMagickMemory(program_name);
1002 execution_path=(char *) RelinquishMagickMemory(execution_path);
1005 return(IsPathAccessible(path));
1009 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1013 % G e t M a g i c k P a g e S i z e %
1017 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1019 % GetMagickPageSize() returns the memory page size.
1021 % The format of the GetMagickPageSize method is:
1023 % long GetMagickPageSize()
1026 MagickExport long GetMagickPageSize(void)
1033 #if defined(MAGICKCORE_HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)
1034 page_size=sysconf(_SC_PAGE_SIZE);
1036 #if defined(MAGICKCORE_HAVE_GETPAGESIZE)
1037 page_size=getpagesize();
1046 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1050 % G e t P a t h A t t r i b u t e s %
1054 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1056 % GetPathAttributes() returns attributes (e.g. size of file) about a path.
1058 % The path of the GetPathAttributes method is:
1060 % MagickBooleanType GetPathAttributes(const char *path,void *attributes)
1062 % A description of each parameter follows.
1064 % o path: the file path.
1066 % o attributes: the path attributes are returned here.
1070 #if defined(MAGICKCORE_HAVE__WFOPEN)
1071 static size_t UTF8ToUTF16(const unsigned char *utf8,wchar_t *utf16)
1073 register const unsigned char
1076 if (utf16 != (wchar_t *) NULL)
1085 Convert UTF-8 to UTF-16.
1088 for (p=utf8; *p != '\0'; p++)
1090 if ((*p & 0x80) == 0)
1093 if ((*p & 0xE0) == 0xC0)
1098 if ((*p & 0xC0) != 0x80)
1103 if ((*p & 0xF0) == 0xE0)
1108 if ((*p & 0xC0) != 0x80)
1111 *q|=(c & 0x3F) << 6;
1113 if ((*p & 0xC0) != 0x80)
1125 Compute UTF-16 string length.
1127 for (p=utf8; *p != '\0'; p++)
1129 if ((*p & 0x80) == 0)
1132 if ((*p & 0xE0) == 0xC0)
1135 if ((*p & 0xC0) != 0x80)
1139 if ((*p & 0xF0) == 0xE0)
1142 if ((*p & 0xC0) != 0x80)
1145 if ((*p & 0xC0) != 0x80)
1154 static wchar_t *ConvertUTF8ToUTF16(const unsigned char *source)
1162 length=UTF8ToUTF16(source,(wchar_t *) NULL);
1169 Not UTF-8, just copy.
1171 length=strlen((const char *) source);
1172 utf16=(wchar_t *) AcquireQuantumMemory(length+1,sizeof(*utf16));
1173 if (utf16 == (wchar_t *) NULL)
1174 return((wchar_t *) NULL);
1175 for (i=0; i <= (long) length; i++)
1179 utf16=(wchar_t *) AcquireQuantumMemory(length+1,sizeof(*utf16));
1180 if (utf16 == (wchar_t *) NULL)
1181 return((wchar_t *) NULL);
1182 length=UTF8ToUTF16(source,utf16);
1187 MagickExport MagickBooleanType GetPathAttributes(const char *path,
1193 if (path == (const char *) NULL)
1196 return(MagickFalse);
1198 #if !defined(MAGICKCORE_HAVE__WSTAT)
1199 status=stat(path,(struct stat *) attributes) == 0 ? MagickTrue : MagickFalse;
1205 unicode_path=ConvertUTF8ToUTF16(path);
1206 if (unicode_path == (wchar_t *) NULL)
1207 return(MagickFalse);
1208 status=wstat(unicode_path,(struct stat *) attributes) == 0 ? MagickTrue :
1210 unicode_path=(wchar_t *) RelinquishMagickMemory(unicode_path);
1217 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1221 % G e t P a t h C o m p o n e n t %
1225 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1227 % GetPathComponent() returns the parent directory name, filename, basename, or
1228 % extension of a file path.
1230 % The format of the GetPathComponent function is:
1232 % GetPathComponent(const char *path,PathType type,char *component)
1234 % A description of each parameter follows:
1236 % o path: Specifies a pointer to a character array that contains the
1239 % o type: Specififies which file path component to return.
1241 % o component: the selected file path component is returned here.
1244 MagickExport void GetPathComponent(const char *path,PathType type,
1248 magick[MaxTextExtent],
1250 subimage[MaxTextExtent];
1255 assert(path != (const char *) NULL);
1256 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",path);
1257 assert(component != (char *) NULL);
1263 (void) CopyMagickString(component,path,MaxTextExtent);
1265 #if defined(__OS2__)
1268 for (p=component; *p != '\0'; p++)
1269 if ((*p == ':') && (IsPathDirectory(path) < 0) &&
1270 (IsPathAccessible(path) == MagickFalse))
1273 Look for image format specification (e.g. ps3:image).
1275 (void) CopyMagickString(magick,component,(size_t) (p-component+1));
1276 if (IsMagickConflict(magick) != MagickFalse)
1279 for (q=component; *q != '\0'; q++)
1286 p=component+strlen(component)-1;
1287 if ((*p == ']') && (strchr(component,'[') != (char *) NULL) &&
1288 (IsPathAccessible(path) == MagickFalse))
1291 Look for scene specification (e.g. img0001.pcd[4]).
1293 for (q=p-1; q > component; q--)
1298 (void) CopyMagickString(subimage,q+1,MaxTextExtent);
1299 subimage[p-q-1]='\0';
1300 if ((IsSceneGeometry(subimage,MagickFalse) == MagickFalse) &&
1301 (IsGeometry(subimage) == MagickFalse))
1309 for (p=component+strlen(component)-1; p > component; p--)
1310 if (IsBasenameSeparator(*p) != MagickFalse)
1316 (void) CopyMagickString(component,magick,MaxTextExtent);
1321 for (p=component+(strlen(component)-1); p > component; p--)
1323 if (IsBasenameSeparator(*p) != MagickFalse)
1339 if (IsBasenameSeparator(*p) != MagickFalse)
1340 (void) CopyMagickMemory((unsigned char *) component,
1341 (const unsigned char *) (p+1),strlen(p+1)+1);
1346 if (IsBasenameSeparator(*p) != MagickFalse)
1347 (void) CopyMagickString(component,p+1,MaxTextExtent);
1348 for (p=component+(strlen(component)-1); p > component; p--)
1358 if (IsBasenameSeparator(*p) != MagickFalse)
1359 (void) CopyMagickString(component,p+1,MaxTextExtent);
1362 for (p=component+strlen(component)-1; p > component; p--)
1367 (void) CopyMagickString(component,p+1,MaxTextExtent);
1372 (void) CopyMagickString(component,subimage,MaxTextExtent);
1382 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1386 % G e t P a t h C o m p o n e n t s %
1390 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1392 % GetPathComponents() returns a list of path components.
1394 % The format of the GetPathComponents method is:
1396 % char **GetPathComponents(const char *path,
1397 % unsigned long *number_componenets)
1399 % A description of each parameter follows:
1401 % o path: Specifies the string to segment into a list.
1403 % o number_components: return the number of components in the list
1406 MagickExport char **GetPathComponents(const char *path,
1407 unsigned long *number_components)
1419 if (path == (char *) NULL)
1420 return((char **) NULL);
1421 *number_components=1;
1422 for (p=path; *p != '\0'; p++)
1423 if (IsBasenameSeparator(*p))
1424 (*number_components)++;
1425 components=(char **) AcquireQuantumMemory((size_t) *number_components+1UL,
1426 sizeof(*components));
1427 if (components == (char **) NULL)
1428 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1430 for (i=0; i < (long) *number_components; i++)
1432 for (q=p; *q != '\0'; q++)
1433 if (IsBasenameSeparator(*q))
1435 components[i]=(char *) AcquireQuantumMemory((size_t) (q-p)+MaxTextExtent,
1436 sizeof(*components));
1437 if (components[i] == (char *) NULL)
1438 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1439 (void) CopyMagickString(components[i],p,(size_t) (q-p+1));
1442 components[i]=(char *) NULL;
1447 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1451 % I s P a t h A c c e s s i b l e %
1455 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1457 % IsPathAccessible() returns MagickTrue if the file as defined by the path is
1460 % The format of the IsPathAccessible method is:
1462 % MagickBooleanType IsPathAccessible(const char *filename)
1464 % A description of each parameter follows.
1466 % o path: Specifies a path to a file.
1469 MagickExport MagickBooleanType IsPathAccessible(const char *path)
1477 if ((path == (const char *) NULL) || (*path == '\0'))
1478 return(MagickFalse);
1479 status=GetPathAttributes(path,&attributes);
1480 if (status == MagickFalse)
1482 if (S_ISREG(attributes.st_mode) == 0)
1483 return(MagickFalse);
1484 if (access(path,F_OK) != 0)
1485 return(MagickFalse);
1490 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1494 + I s P a t h D i r e c t o r y %
1498 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1500 % IsPathDirectory() returns -1 if the directory does not exist, 1 is returned
1501 % if the path represents a directory otherwise 0.
1503 % The format of the IsPathDirectory method is:
1505 % int IsPathDirectory(const char *path)
1507 % A description of each parameter follows.
1509 % o path: The directory path.
1512 static int IsPathDirectory(const char *path)
1520 if ((path == (const char *) NULL) || (*path == '\0'))
1521 return(MagickFalse);
1522 status=GetPathAttributes(path,&attributes);
1523 if (status == MagickFalse)
1525 if (S_ISDIR(attributes.st_mode) == 0)
1531 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1535 % I s M a g i c k T r u e %
1539 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1541 % IsMagickTrue() returns MagickTrue if the value is "true", "on", "yes" or
1544 % The format of the IsMagickTrue method is:
1546 % MagickBooleanType IsMagickTrue(const char *value)
1548 % A description of each parameter follows:
1550 % o option: either MagickTrue or MagickFalse depending on the value
1553 % o value: Specifies a pointer to a character array.
1556 MagickExport MagickBooleanType IsMagickTrue(const char *value)
1558 if (value == (const char *) NULL)
1559 return(MagickFalse);
1560 if (LocaleCompare(value,"true") == 0)
1562 if (LocaleCompare(value,"on") == 0)
1564 if (LocaleCompare(value,"yes") == 0)
1566 if (LocaleCompare(value,"1") == 0)
1568 return(MagickFalse);
1572 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1576 % L i s t F i l e s %
1580 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1582 % ListFiles() reads the directory specified and returns a list of filenames
1583 % contained in the directory sorted in ascending alphabetic order.
1585 % The format of the ListFiles function is:
1587 % char **ListFiles(const char *directory,const char *pattern,
1588 % long *number_entries)
1590 % A description of each parameter follows:
1592 % o filelist: Method ListFiles returns a list of filenames contained
1593 % in the directory. If the directory specified cannot be read or it is
1594 % a file a NULL list is returned.
1596 % o directory: Specifies a pointer to a text string containing a directory
1599 % o pattern: Specifies a pointer to a text string containing a pattern.
1601 % o number_entries: This integer returns the number of filenames in the
1606 #if defined(__cplusplus) || defined(c_plusplus)
1610 static int FileCompare(const void *x,const void *y)
1616 p=(const char **) x;
1617 q=(const char **) y;
1618 return(LocaleCompare(*p,*q));
1621 #if defined(__cplusplus) || defined(c_plusplus)
1625 static inline int MagickReadDirectory(DIR *directory,struct dirent *entry,
1626 struct dirent **result)
1628 #if defined(MAGICKCORE_HAVE_READDIR_R)
1629 return(readdir_r(directory,entry,result));
1633 *result=readdir(directory);
1638 MagickExport char **ListFiles(const char *directory,const char *pattern,
1639 unsigned long *number_entries)
1657 assert(directory != (const char *) NULL);
1658 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",directory);
1659 assert(pattern != (const char *) NULL);
1660 assert(number_entries != (unsigned long *) NULL);
1662 current_directory=opendir(directory);
1663 if (current_directory == (DIR *) NULL)
1664 return((char **) NULL);
1669 filelist=(char **) AcquireQuantumMemory((size_t) max_entries,
1671 if (filelist == (char **) NULL)
1673 (void) closedir(current_directory);
1674 return((char **) NULL);
1677 Save the current and change to the new directory.
1679 buffer=(struct dirent *) AcquireAlignedMemory(1,sizeof(*buffer)+FILENAME_MAX+1);
1680 if (buffer == (struct dirent *) NULL)
1681 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1682 while ((MagickReadDirectory(current_directory,buffer,&entry) == 0) &&
1683 (entry != (struct dirent *) NULL))
1685 if (*entry->d_name == '.')
1687 if ((IsPathDirectory(entry->d_name) > 0) ||
1688 #if defined(MAGICKCORE_WINDOWS_SUPPORT)
1689 (GlobExpression(entry->d_name,pattern,MagickTrue) != MagickFalse))
1691 (GlobExpression(entry->d_name,pattern,MagickFalse) != MagickFalse))
1694 if (*number_entries >= max_entries)
1697 Extend the file list.
1700 filelist=(char **) ResizeQuantumMemory(filelist,(size_t)
1701 max_entries,sizeof(*filelist));
1702 if (filelist == (char **) NULL)
1710 p=strchr(entry->d_name,';');
1713 if (*number_entries > 0)
1714 if (LocaleCompare(entry->d_name,filelist[*number_entries-1]) == 0)
1718 filelist[*number_entries]=(char *) AcquireString(entry->d_name);
1719 if (IsPathDirectory(entry->d_name) > 0)
1720 (void) ConcatenateMagickString(filelist[*number_entries],
1721 DirectorySeparator,MaxTextExtent);
1722 (*number_entries)++;
1725 buffer=(struct dirent *) RelinquishMagickMemory(buffer);
1726 (void) closedir(current_directory);
1727 if (filelist == (char **) NULL)
1728 return((char **) NULL);
1730 Sort filelist in ascending order.
1732 qsort((void *) filelist,(size_t) *number_entries,sizeof(*filelist),
1738 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1742 % M u l t i l i n e C e n s u s %
1746 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1748 % MultilineCensus() returns the number of lines within a label. A line is
1749 % represented by a \n character.
1751 % The format of the MultilineCenus method is:
1753 % unsigned long MultilineCensus(const char *label)
1755 % A description of each parameter follows.
1757 % o label: This character string is the label.
1761 MagickExport unsigned long MultilineCensus(const char *label)
1767 Determine the number of lines within this label.
1769 if (label == (char *) NULL)
1771 for (number_lines=1; *label != '\0'; label++)
1774 return(number_lines);
1778 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1782 % O p e n M a g i c k S t r e a m %
1786 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1788 % OpenMagickStream() opens the file at the specified path and return the
1789 % associated stream.
1791 % The path of the OpenMagickStream method is:
1793 % FILE *OpenMagickStream(const char *path,const char *mode)
1795 % A description of each parameter follows.
1797 % o path: the file path.
1799 % o mode: the file mode.
1802 MagickExport FILE *OpenMagickStream(const char *path,const char *mode)
1807 if ((path == (const char *) NULL) || (mode == (const char *) NULL))
1810 return((FILE *) NULL);
1813 #if defined(MAGICKCORE_HAVE__WFOPEN)
1819 unicode_path=ConvertUTF8ToUTF16(path);
1820 if (unicode_path == (wchar_t *) NULL)
1821 return((FILE *) NULL);
1822 unicode_mode=ConvertUTF8ToUTF16(mode);
1823 if (unicode_mode == (wchar_t *) NULL)
1825 unicode_path=(wchar_t *) RelinquishMagickMemory(unicode_path);
1826 return((FILE *) NULL);
1828 file=_wfopen(unicode_path,unicode_mode);
1829 unicode_mode=(wchar_t *) RelinquishMagickMemory(unicode_mode);
1830 unicode_path=(wchar_t *) RelinquishMagickMemory(unicode_path);
1833 if (file == (FILE *) NULL)
1834 file=fopen(path,mode);
1839 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1843 % S y s t e m C o m m a n d %
1847 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1849 % SystemCommand() executes the specified command and waits until it
1850 % terminates. The returned value is the exit status of the command.
1852 % The format of the SystemCommand method is:
1854 % int SystemCommand(const MagickBooleanType asynchronous,
1855 % const MagickBooleanType verbose,const char *command,
1856 % ExceptionInfo *exception)
1858 % A description of each parameter follows:
1860 % o asynchronous: a value other than 0 executes the parent program
1861 % concurrently with the new child process.
1863 % o verbose: a value other than 0 prints the executed command before it is
1866 % o command: this string is the command to execute.
1868 % o exception: return any errors here.
1871 MagickExport int SystemCommand(const MagickBooleanType asynchronous,
1872 const MagickBooleanType verbose,const char *command,ExceptionInfo *exception)
1892 arguments=StringToArgv(command,&number_arguments);
1893 if (arguments == (char **) NULL)
1895 rights=ExecutePolicyRights;
1896 domain=DelegatePolicyDomain;
1897 if (IsRightsAuthorized(domain,rights,arguments[1]) == MagickFalse)
1900 (void) ThrowMagickException(exception,GetMagickModule(),PolicyError,
1901 "NotAuthorized","`%s'",arguments[1]);
1902 for (i=0; i < number_arguments; i++)
1903 arguments[i]=DestroyString(arguments[i]);
1904 arguments=(char **) RelinquishMagickMemory(arguments);
1907 if (verbose != MagickFalse)
1909 (void) fprintf(stderr,"%s\n",command);
1910 (void) fflush(stderr);
1912 shell_command=(char *) command;
1913 if (asynchronous != MagickFalse)
1915 shell_command=AcquireString(command);
1916 (void) ConcatenateMagickString(shell_command,"&",MaxTextExtent);
1918 #if defined(MAGICKCORE_POSIX_SUPPORT)
1919 #if !defined(MAGICKCORE_HAVE_EXECVP)
1920 status=system(shell_command);
1922 if ((asynchronous != MagickFalse) || (strspn(shell_command,"&;<>|") == 0))
1923 status=system(shell_command);
1930 Call application directly rather than from a shell.
1933 if (child_pid == (pid_t) -1)
1934 status=system(command);
1938 status=execvp(arguments[1],arguments+1);
1950 pid=waitpid(child_pid,&child_status,0);
1955 if (WIFEXITED(child_status) != 0)
1956 status=WEXITSTATUS(child_status);
1958 if (WIFSIGNALED(child_status))
1964 #elif defined(MAGICKCORE_WINDOWS_SUPPORT)
1970 if (asynchronous != MagickFalse)
1972 status=spawnvp(mode,arguments[1],arguments+1);
1974 #elif defined(macintosh)
1975 status=MACSystemCommand(shell_command);
1977 status=system(shell_command);
1979 # error No suitable system() method.
1982 (void) ThrowMagickException(exception,GetMagickModule(),DelegateError,
1983 "`%s' (%d)",command,status);
1984 if (shell_command != command)
1985 shell_command=DestroyString(shell_command);
1986 for (i=0; i < number_arguments; i++)
1987 arguments[i]=DestroyString(arguments[i]);
1988 arguments=(char **) RelinquishMagickMemory(arguments);