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 given argument array, and
679 % expands it if they have a wildcard character.
681 % Any coder prefix (EG: 'coder:filename') or read modifier postfix (EG:
682 % 'filename[...]') are ignored during the file the expansion, but will be
683 % included in the final argument. If no filename matching the meta-character
684 % 'glob' is found the original argument is returned.
686 % For example, an argument of '*.gif[20x20]' will be replaced by the list
687 % 'abc.gif[20x20]', 'foobar.gif[20x20]', 'xyzzy.gif[20x20]'
688 % if such filenames exist, (in the current directory in this case).
690 % Meta-characters handled...
691 % @ read a list of filenames (no further expansion performed)
692 % ~ At start of filename expands to HOME environemtn variable
693 % * matches any string including an empty string
694 % ? matches by any single character
696 % WARNING: filenames starting with '.' (hidden files in a UNIX file system)
697 % will never be expanded. Attempting to epand '.*' will produce no change.
699 % Expansion is ignored for coders "label:" "caption:" "pango:" and "vid:".
700 % Which provide their own '@' meta-character handling.
703 % The format of the ExpandFilenames function is:
705 % status=ExpandFilenames(int *number_arguments,char ***arguments)
707 % A description of each parameter follows:
709 % o number_arguments: Specifies a pointer to an integer describing the
710 % number of elements in the argument vector.
712 % o arguments: Specifies a pointer to a text array containing the command
716 MagickExport MagickBooleanType ExpandFilenames(int *number_arguments,
721 home_directory[MaxTextExtent],
736 Allocate argument vector.
738 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
739 assert(number_arguments != (int *) NULL);
740 assert(arguments != (char ***) NULL);
741 vector=(char **) AcquireQuantumMemory((size_t) (*number_arguments+1),
743 if (vector == (char **) NULL)
744 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
746 Expand any wildcard filenames.
748 *home_directory='\0';
750 for (i=0; i < (ssize_t) *number_arguments; i++)
754 filename[MaxTextExtent],
755 magick[MaxTextExtent],
758 subimage[MaxTextExtent];
763 option=(*arguments)[i];
768 vector[count++]=ConstantString(option);
770 parameters=ParseCommandOption(MagickCommandOptions,MagickFalse,option);
774 Do not expand command option parameters.
776 for (j=0; j < parameters; j++)
779 if (i == (ssize_t) *number_arguments)
781 option=(*arguments)[i];
782 vector[count++]=ConstantString(option);
786 if ((*option == '"') || (*option == '\''))
788 GetPathComponent(option,CanonicalPath,filename);
789 GetPathComponent(option,MagickPath,magick);
790 if ((LocaleCompare(magick,"CAPTION") == 0) ||
791 (LocaleCompare(magick,"LABEL") == 0) ||
792 (LocaleCompare(magick,"PANGO") == 0) ||
793 (LocaleCompare(magick,"VID") == 0))
795 if ((IsGlob(option) == MagickFalse) && (*option != '@'))
800 Generate file list from wildcard filename (e.g. *.jpg).
802 GetPathComponent(option,HeadPath,path);
803 GetPathComponent(option,SubimagePath,subimage);
804 ExpandFilename(path);
805 if (*home_directory == '\0')
806 directory=getcwd(home_directory,MaxTextExtent-1);
808 filelist=ListFiles(*path == '\0' ? home_directory : path,option,
823 Generate file list from file list (e.g. @filelist.txt).
825 exception=AcquireExceptionInfo();
826 files=FileToString(option+1,~0,exception);
827 exception=DestroyExceptionInfo(exception);
828 if (files == (char *) NULL)
830 filelist=StringToArgv(files,&length);
831 if (filelist == (char **) NULL)
833 files=DestroyString(files);
834 filelist[0]=DestroyString(filelist[0]);
835 for (j=0; j < (ssize_t) (length-1); j++)
836 filelist[j]=filelist[j+1];
837 number_files=(size_t) length-1;
839 if (filelist == (char **) NULL)
841 for (j=0; j < (ssize_t) number_files; j++)
842 if (IsPathDirectory(filelist[j]) <= 0)
844 if (j == (ssize_t) number_files)
846 for (j=0; j < (ssize_t) number_files; j++)
847 filelist[j]=DestroyString(filelist[j]);
848 filelist=(char **) RelinquishMagickMemory(filelist);
852 Transfer file list to argument vector.
854 vector=(char **) ResizeQuantumMemory(vector,(size_t) *number_arguments+
855 count+number_files+1,sizeof(*vector));
856 if (vector == (char **) NULL)
858 for (j=0; j < (ssize_t) number_files; j++)
861 parameters=ParseCommandOption(MagickCommandOptions,MagickFalse,option);
868 Do not expand command option parameters.
870 vector[count++]=ConstantString(option);
871 for (k=0; k < parameters; k++)
874 if (j == (ssize_t) number_files)
877 vector[count++]=ConstantString(option);
881 (void) CopyMagickString(filename,path,MaxTextExtent);
883 (void) ConcatenateMagickString(filename,DirectorySeparator,
885 (void) ConcatenateMagickString(filename,filelist[j],MaxTextExtent);
886 filelist[j]=DestroyString(filelist[j]);
887 if (strlen(filename) >= (MaxTextExtent-1))
888 ThrowFatalException(OptionFatalError,"FilenameTruncated");
889 if (IsPathDirectory(filename) <= 0)
897 (void) ConcatenateMagickString(path,magick,MaxTextExtent);
898 (void) ConcatenateMagickString(path,":",MaxTextExtent);
900 (void) ConcatenateMagickString(path,filename,MaxTextExtent);
901 if (*subimage != '\0')
903 (void) ConcatenateMagickString(path,"[",MaxTextExtent);
904 (void) ConcatenateMagickString(path,subimage,MaxTextExtent);
905 (void) ConcatenateMagickString(path,"]",MaxTextExtent);
907 if (strlen(path) >= (MaxTextExtent-1))
908 ThrowFatalException(OptionFatalError,"FilenameTruncated");
909 if (destroy != MagickFalse)
912 vector[count]=DestroyString(vector[count]);
915 vector[count++]=ConstantString(path);
918 filelist=(char **) RelinquishMagickMemory(filelist);
920 vector[count]=(char *) NULL;
921 if (IsEventLogging() != MagickFalse)
926 command_line=AcquireString(vector[0]);
927 for (i=1; i < count; i++)
929 (void) ConcatenateString(&command_line," {");
930 (void) ConcatenateString(&command_line,vector[i]);
931 (void) ConcatenateString(&command_line,"}");
933 (void) LogMagickEvent(ConfigureEvent,GetMagickModule(),
934 "Command line: %s",command_line);
935 command_line=DestroyString(command_line);
937 *number_arguments=(int) count;
943 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
947 % G e t E x e c u t i o n P a t h %
951 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
953 % GetExecutionPath() returns the pathname of the executable that started
954 % the process. On success MagickTrue is returned, otherwise MagickFalse.
956 % The format of the GetExecutionPath method is:
958 % MagickBooleanType GetExecutionPath(char *path,const size_t extent)
960 % A description of each parameter follows:
962 % o path: the pathname of the executable that started the process.
964 % o extent: the maximum extent of the path.
967 MagickPrivate MagickBooleanType GetExecutionPath(char *path,const size_t extent)
973 directory=getcwd(path,(unsigned long) extent);
975 #if defined(MAGICKCORE_HAVE_GETPID) && defined(MAGICKCORE_HAVE_READLINK) && defined(PATH_MAX)
978 link_path[MaxTextExtent],
979 execution_path[PATH_MAX+1];
984 (void) FormatLocaleString(link_path,MaxTextExtent,"/proc/%.20g/exe",
986 count=readlink(link_path,execution_path,PATH_MAX);
989 (void) FormatLocaleString(link_path,MaxTextExtent,"/proc/%.20g/file",
991 count=readlink(link_path,execution_path,PATH_MAX);
993 if ((count > 0) && (count <= (ssize_t) PATH_MAX))
995 execution_path[count]='\0';
996 (void) CopyMagickString(path,execution_path,extent);
1000 #if defined(MAGICKCORE_HAVE__NSGETEXECUTABLEPATH)
1003 executable_path[PATH_MAX << 1],
1004 execution_path[PATH_MAX+1];
1009 length=sizeof(executable_path);
1010 if ((_NSGetExecutablePath(executable_path,&length) == 0) &&
1011 (realpath(executable_path,execution_path) != (char *) NULL))
1012 (void) CopyMagickString(path,execution_path,extent);
1015 #if defined(MAGICKCORE_HAVE_GETEXECNAME)
1020 execution_path=(const char *) getexecname();
1021 if (execution_path != (const char *) NULL)
1023 if (*execution_path != *DirectorySeparator)
1024 (void) ConcatenateMagickString(path,DirectorySeparator,extent);
1025 (void) ConcatenateMagickString(path,execution_path,extent);
1029 #if defined(MAGICKCORE_WINDOWS_SUPPORT)
1030 NTGetExecutionPath(path,extent);
1032 #if defined(__GNU__)
1042 execution_path=(char *) NULL;
1043 program_name=program_invocation_name;
1044 if (*program_invocation_name != '/')
1049 extent=strlen(directory)+strlen(program_name)+2;
1050 program_name=AcquireQuantumMemory(extent,sizeof(*program_name));
1051 if (program_name == (char *) NULL)
1052 program_name=program_invocation_name;
1054 count=FormatLocaleString(program_name,extent,"%s/%s",directory,
1055 program_invocation_name);
1059 execution_path=realpath(program_name,NULL);
1060 if (execution_path != (char *) NULL)
1061 (void) CopyMagickString(path,execution_path,extent);
1063 if (program_name != program_invocation_name)
1064 program_name=(char *) RelinquishMagickMemory(program_name);
1065 execution_path=(char *) RelinquishMagickMemory(execution_path);
1068 return(IsPathAccessible(path));
1072 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1076 % G e t M a g i c k P a g e S i z e %
1080 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1082 % GetMagickPageSize() returns the memory page size.
1084 % The format of the GetMagickPageSize method is:
1086 % ssize_t GetMagickPageSize()
1089 MagickPrivate ssize_t GetMagickPageSize(void)
1096 #if defined(MAGICKCORE_HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)
1097 page_size=(ssize_t) sysconf(_SC_PAGE_SIZE);
1099 #if defined(MAGICKCORE_HAVE_GETPAGESIZE)
1100 page_size=(ssize_t) getpagesize();
1109 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1113 % G e t P a t h A t t r i b u t e s %
1117 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1119 % GetPathAttributes() returns attributes (e.g. size of file) about a path.
1121 % The path of the GetPathAttributes method is:
1123 % MagickBooleanType GetPathAttributes(const char *path,void *attributes)
1125 % A description of each parameter follows.
1127 % o path: the file path.
1129 % o attributes: the path attributes are returned here.
1132 MagickExport MagickBooleanType GetPathAttributes(const char *path,
1138 if (path == (const char *) NULL)
1141 return(MagickFalse);
1143 status=stat_utf8(path,(struct stat *) attributes) == 0 ? MagickTrue :
1149 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1153 % G e t P a t h C o m p o n e n t %
1157 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1159 % GetPathComponent() returns the parent directory name, filename, basename, or
1160 % extension of a file path.
1162 % The format of the GetPathComponent function is:
1164 % GetPathComponent(const char *path,PathType type,char *component)
1166 % A description of each parameter follows:
1168 % o path: Specifies a pointer to a character array that contains the
1171 % o type: Specififies which file path component to return.
1173 % o component: the selected file path component is returned here.
1176 MagickExport void GetPathComponent(const char *path,PathType type,
1180 magick[MaxTextExtent],
1182 subimage[MaxTextExtent];
1187 assert(path != (const char *) NULL);
1188 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",path);
1189 assert(component != (char *) NULL);
1195 (void) CopyMagickString(component,path,MaxTextExtent);
1197 #if defined(__OS2__)
1200 for (p=component; *p != '\0'; p++)
1202 if ((*p == '%') && (*(p+1) == '['))
1207 for (p++; (*p != ']') && (*p != '\0'); p++) ;
1211 if ((*p == ':') && (IsPathDirectory(path) < 0) &&
1212 (IsPathAccessible(path) == MagickFalse))
1215 Look for image format specification (e.g. ps3:image).
1217 (void) CopyMagickString(magick,component,(size_t) (p-component+1));
1218 if (IsMagickConflict(magick) != MagickFalse)
1221 for (q=component; *q != '\0'; q++)
1229 p=component+strlen(component)-1;
1230 if ((*p == ']') && (strchr(component,'[') != (char *) NULL) &&
1231 (IsPathAccessible(path) == MagickFalse))
1234 Look for scene specification (e.g. img0001.pcd[4]).
1236 for (q=p-1; q > component; q--)
1241 (void) CopyMagickString(subimage,q+1,MaxTextExtent);
1242 subimage[p-q-1]='\0';
1243 if ((IsSceneGeometry(subimage,MagickFalse) == MagickFalse) &&
1244 (IsGeometry(subimage) == MagickFalse))
1252 for (p=component+strlen(component)-1; p > component; p--)
1253 if (IsBasenameSeparator(*p) != MagickFalse)
1259 (void) CopyMagickString(component,magick,MaxTextExtent);
1264 for (p=component+(strlen(component)-1); p > component; p--)
1266 if (IsBasenameSeparator(*p) != MagickFalse)
1282 if (IsBasenameSeparator(*p) != MagickFalse)
1283 (void) CopyMagickMemory((unsigned char *) component,
1284 (const unsigned char *) (p+1),strlen(p+1)+1);
1289 if (IsBasenameSeparator(*p) != MagickFalse)
1290 (void) CopyMagickString(component,p+1,MaxTextExtent);
1291 for (p=component+(strlen(component)-1); p > component; p--)
1301 if (IsBasenameSeparator(*p) != MagickFalse)
1302 (void) CopyMagickString(component,p+1,MaxTextExtent);
1305 for (p=component+strlen(component)-1; p > component; p--)
1310 (void) CopyMagickString(component,p+1,MaxTextExtent);
1315 (void) CopyMagickString(component,subimage,MaxTextExtent);
1325 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1329 % G e t P a t h C o m p o n e n t s %
1333 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1335 % GetPathComponents() returns a list of path components.
1337 % The format of the GetPathComponents method is:
1339 % char **GetPathComponents(const char *path,
1340 % size_t *number_componenets)
1342 % A description of each parameter follows:
1344 % o path: Specifies the string to segment into a list.
1346 % o number_components: return the number of components in the list
1349 MagickPrivate char **GetPathComponents(const char *path,
1350 size_t *number_components)
1362 if (path == (char *) NULL)
1363 return((char **) NULL);
1364 *number_components=1;
1365 for (p=path; *p != '\0'; p++)
1366 if (IsBasenameSeparator(*p))
1367 (*number_components)++;
1368 components=(char **) AcquireQuantumMemory((size_t) *number_components+1UL,
1369 sizeof(*components));
1370 if (components == (char **) NULL)
1371 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1373 for (i=0; i < (ssize_t) *number_components; i++)
1375 for (q=p; *q != '\0'; q++)
1376 if (IsBasenameSeparator(*q))
1378 components[i]=(char *) AcquireQuantumMemory((size_t) (q-p)+MaxTextExtent,
1379 sizeof(**components));
1380 if (components[i] == (char *) NULL)
1381 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1382 (void) CopyMagickString(components[i],p,(size_t) (q-p+1));
1385 components[i]=(char *) NULL;
1390 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1394 % I s P a t h A c c e s s i b l e %
1398 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1400 % IsPathAccessible() returns MagickTrue if the file as defined by the path is
1403 % The format of the IsPathAccessible method is:
1405 % MagickBooleanType IsPathAccessible(const char *filename)
1407 % A description of each parameter follows.
1409 % o path: Specifies a path to a file.
1412 MagickExport MagickBooleanType IsPathAccessible(const char *path)
1420 if ((path == (const char *) NULL) || (*path == '\0'))
1421 return(MagickFalse);
1422 status=GetPathAttributes(path,&attributes);
1423 if (status == MagickFalse)
1425 if (S_ISREG(attributes.st_mode) == 0)
1426 return(MagickFalse);
1427 if (access_utf8(path,F_OK) != 0)
1428 return(MagickFalse);
1433 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1437 + I s P a t h D i r e c t o r y %
1441 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1443 % IsPathDirectory() returns -1 if the directory does not exist, 1 is returned
1444 % if the path represents a directory otherwise 0.
1446 % The format of the IsPathDirectory method is:
1448 % int IsPathDirectory(const char *path)
1450 % A description of each parameter follows.
1452 % o path: The directory path.
1455 static int IsPathDirectory(const char *path)
1463 if ((path == (const char *) NULL) || (*path == '\0'))
1464 return(MagickFalse);
1465 status=GetPathAttributes(path,&attributes);
1466 if (status == MagickFalse)
1468 if (S_ISDIR(attributes.st_mode) == 0)
1474 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1478 % L i s t F i l e s %
1482 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1484 % ListFiles() reads the directory specified and returns a list of filenames
1485 % contained in the directory sorted in ascending alphabetic order.
1487 % The format of the ListFiles function is:
1489 % char **ListFiles(const char *directory,const char *pattern,
1490 % ssize_t *number_entries)
1492 % A description of each parameter follows:
1494 % o filelist: Method ListFiles returns a list of filenames contained
1495 % in the directory. If the directory specified cannot be read or it is
1496 % a file a NULL list is returned.
1498 % o directory: Specifies a pointer to a text string containing a directory
1501 % o pattern: Specifies a pointer to a text string containing a pattern.
1503 % o number_entries: This integer returns the number of filenames in the
1508 #if defined(__cplusplus) || defined(c_plusplus)
1512 static int FileCompare(const void *x,const void *y)
1518 p=(const char **) x;
1519 q=(const char **) y;
1520 return(LocaleCompare(*p,*q));
1523 #if defined(__cplusplus) || defined(c_plusplus)
1527 static inline int MagickReadDirectory(DIR *directory,struct dirent *entry,
1528 struct dirent **result)
1530 #if defined(MAGICKCORE_HAVE_READDIR_R)
1531 return(readdir_r(directory,entry,result));
1535 *result=readdir(directory);
1540 MagickPrivate char **ListFiles(const char *directory,const char *pattern,
1541 size_t *number_entries)
1559 assert(directory != (const char *) NULL);
1560 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",directory);
1561 assert(pattern != (const char *) NULL);
1562 assert(number_entries != (size_t *) NULL);
1564 current_directory=opendir(directory);
1565 if (current_directory == (DIR *) NULL)
1566 return((char **) NULL);
1571 filelist=(char **) AcquireQuantumMemory((size_t) max_entries,
1573 if (filelist == (char **) NULL)
1575 (void) closedir(current_directory);
1576 return((char **) NULL);
1579 Save the current and change to the new directory.
1581 buffer=(struct dirent *) AcquireMagickMemory(sizeof(*buffer)+
1583 if (buffer == (struct dirent *) NULL)
1584 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1585 while ((MagickReadDirectory(current_directory,buffer,&entry) == 0) &&
1586 (entry != (struct dirent *) NULL))
1588 if (*entry->d_name == '.')
1590 if ((IsPathDirectory(entry->d_name) > 0) ||
1591 #if defined(MAGICKCORE_WINDOWS_SUPPORT)
1592 (GlobExpression(entry->d_name,pattern,MagickTrue) != MagickFalse))
1594 (GlobExpression(entry->d_name,pattern,MagickFalse) != MagickFalse))
1597 if (*number_entries >= max_entries)
1600 Extend the file list.
1603 filelist=(char **) ResizeQuantumMemory(filelist,(size_t)
1604 max_entries,sizeof(*filelist));
1605 if (filelist == (char **) NULL)
1613 p=strchr(entry->d_name,';');
1616 if (*number_entries > 0)
1617 if (LocaleCompare(entry->d_name,filelist[*number_entries-1]) == 0)
1621 filelist[*number_entries]=(char *) AcquireString(entry->d_name);
1622 (*number_entries)++;
1625 buffer=(struct dirent *) RelinquishMagickMemory(buffer);
1626 (void) closedir(current_directory);
1627 if (filelist == (char **) NULL)
1628 return((char **) NULL);
1630 Sort filelist in ascending order.
1632 qsort((void *) filelist,(size_t) *number_entries,sizeof(*filelist),
1638 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1642 % M a g i c k D e l a y %
1646 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1648 % MagickDelay() suspends program execution for the number of milliseconds
1651 % The format of the Delay method is:
1653 % void MagickDelay(const MagickSizeType milliseconds)
1655 % A description of each parameter follows:
1657 % o milliseconds: Specifies the number of milliseconds to delay before
1661 MagickPrivate void MagickDelay(const MagickSizeType milliseconds)
1663 if (milliseconds == 0)
1665 #if defined(MAGICKCORE_HAVE_NANOSLEEP)
1670 timer.tv_sec=(time_t) (milliseconds/1000);
1671 timer.tv_nsec=(milliseconds % 1000)*1000*1000;
1672 (void) nanosleep(&timer,(struct timespec *) NULL);
1674 #elif defined(MAGICKCORE_HAVE_USLEEP)
1675 usleep(1000*milliseconds);
1676 #elif defined(MAGICKCORE_HAVE_SELECT)
1681 timer.tv_sec=(long) milliseconds/1000;
1682 timer.tv_usec=(long) (milliseconds % 1000)*1000;
1683 (void) select(0,(XFD_SET *) NULL,(XFD_SET *) NULL,(XFD_SET *) NULL,&timer);
1685 #elif defined(MAGICKCORE_HAVE_POLL)
1686 (void) poll((struct pollfd *) NULL,0,(int) milliseconds);
1687 #elif defined(MAGICKCORE_WINDOWS_SUPPORT)
1688 Sleep((long) milliseconds);
1694 timer=milliseconds/1000.0;
1697 #elif defined(__BEOS__)
1698 snooze(1000*milliseconds);
1700 # error "Time delay method not defined."
1705 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1709 % M u l t i l i n e C e n s u s %
1713 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1715 % MultilineCensus() returns the number of lines within a label. A line is
1716 % represented by a \n character.
1718 % The format of the MultilineCenus method is:
1720 % size_t MultilineCensus(const char *label)
1722 % A description of each parameter follows.
1724 % o label: This character string is the label.
1727 MagickExport size_t MultilineCensus(const char *label)
1733 Determine the number of lines within this label.
1735 if (label == (char *) NULL)
1737 for (number_lines=1; *label != '\0'; label++)
1740 return(number_lines);
1744 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1748 % S y s t e m C o m m a n d %
1752 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1754 % SystemCommand() executes the specified command and waits until it
1755 % terminates. The returned value is the exit status of the command.
1757 % The format of the SystemCommand method is:
1759 % int SystemCommand(const MagickBooleanType asynchronous,
1760 % const MagickBooleanType verbose,const char *command,
1761 % ExceptionInfo *exception)
1763 % A description of each parameter follows:
1765 % o asynchronous: a value other than 0 executes the parent program
1766 % concurrently with the new child process.
1768 % o verbose: a value other than 0 prints the executed command before it is
1771 % o command: this string is the command to execute.
1773 % o exception: return any errors here.
1776 MagickExport int SystemCommand(const MagickBooleanType asynchronous,
1777 const MagickBooleanType verbose,const char *command,ExceptionInfo *exception)
1797 arguments=StringToArgv(command,&number_arguments);
1798 if (arguments == (char **) NULL)
1800 rights=ExecutePolicyRights;
1801 domain=DelegatePolicyDomain;
1802 if (IsRightsAuthorized(domain,rights,arguments[1]) == MagickFalse)
1805 (void) ThrowMagickException(exception,GetMagickModule(),PolicyError,
1806 "NotAuthorized","'%s'",arguments[1]);
1807 for (i=0; i < (ssize_t) number_arguments; i++)
1808 arguments[i]=DestroyString(arguments[i]);
1809 arguments=(char **) RelinquishMagickMemory(arguments);
1812 if (verbose != MagickFalse)
1814 (void) FormatLocaleFile(stderr,"%s\n",command);
1815 (void) fflush(stderr);
1817 shell_command=(char *) command;
1818 if (asynchronous != MagickFalse)
1820 shell_command=AcquireString(command);
1821 (void) ConcatenateMagickString(shell_command,"&",MaxTextExtent);
1823 #if defined(MAGICKCORE_POSIX_SUPPORT)
1824 #if !defined(MAGICKCORE_HAVE_EXECVP)
1825 status=system(shell_command);
1827 if ((asynchronous != MagickFalse) ||
1828 (strpbrk(shell_command,"&;<>|") != (char *) NULL))
1829 status=system(shell_command);
1836 Call application directly rather than from a shell.
1838 child_pid=(pid_t) fork();
1839 if (child_pid == (pid_t) -1)
1840 status=system(command);
1844 status=execvp(arguments[1],arguments+1);
1856 pid=(pid_t) waitpid(child_pid,&child_status,0);
1861 if (WIFEXITED(child_status) != 0)
1862 status=WEXITSTATUS(child_status);
1864 if (WIFSIGNALED(child_status))
1870 #elif defined(MAGICKCORE_WINDOWS_SUPPORT)
1871 status=NTSystemCommand(shell_command);
1872 #elif defined(macintosh)
1873 status=MACSystemCommand(shell_command);
1875 status=system(shell_command);
1877 # error No suitable system() method.
1880 (void) ThrowMagickException(exception,GetMagickModule(),DelegateError,
1881 "'%s' (%d)",command,status);
1882 if (shell_command != command)
1883 shell_command=DestroyString(shell_command);
1884 for (i=0; i < (ssize_t) number_arguments; i++)
1885 arguments[i]=DestroyString(arguments[i]);
1886 arguments=(char **) RelinquishMagickMemory(arguments);