• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %                                                                             %
4 %                                                                             %
5 %                                                                             %
6 %             U   U  TTTTT  IIIII  L      IIIII  TTTTT  Y   Y                 %
7 %             U   U    T      I    L        I      T     Y Y                  %
8 %             U   U    T      I    L        I      T      Y                   %
9 %             U   U    T      I    L        I      T      Y                   %
10 %              UUU     T    IIIII  LLLLL  IIIII    T      Y                   %
11 %                                                                             %
12 %                                                                             %
13 %                       MagickCore Utility Methods                            %
14 %                                                                             %
15 %                             Software Design                                 %
16 %                                  Cristy                                     %
17 %                              January 1993                                   %
18 %                                                                             %
19 %                                                                             %
20 %  Copyright 1999-2020 ImageMagick Studio LLC, a non-profit organization      %
21 %  dedicated to making software imaging solutions freely available.           %
22 %                                                                             %
23 %  You may not use this file except in compliance with the License.  You may  %
24 %  obtain a copy of the License at                                            %
25 %                                                                             %
26 %    https://imagemagick.org/script/license.php                               %
27 %                                                                             %
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.                                             %
33 %                                                                             %
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
35 %
36 %
37 */
38 
39 /*
40   Include declarations.
41 */
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/image-private.h"
50 #include "MagickCore/list.h"
51 #include "MagickCore/log.h"
52 #include "MagickCore/magick-private.h"
53 #include "MagickCore/memory_.h"
54 #include "MagickCore/nt-base-private.h"
55 #include "MagickCore/option.h"
56 #include "MagickCore/policy.h"
57 #include "MagickCore/random_.h"
58 #include "MagickCore/registry.h"
59 #include "MagickCore/resource_.h"
60 #include "MagickCore/semaphore.h"
61 #include "MagickCore/signature-private.h"
62 #include "MagickCore/statistic.h"
63 #include "MagickCore/string_.h"
64 #include "MagickCore/string-private.h"
65 #include "MagickCore/token.h"
66 #include "MagickCore/token-private.h"
67 #include "MagickCore/utility.h"
68 #include "MagickCore/utility-private.h"
69 #if defined(MAGICKCORE_HAVE_PROCESS_H)
70 #include <process.h>
71 #endif
72 #if defined(MAGICKCORE_HAVE_MACH_O_DYLD_H)
73 #include <mach-o/dyld.h>
74 #endif
75 
76 /*
77   Static declarations.
78 */
79 static const char
80   Base64[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
81 
82 /*
83   Forward declaration.
84 */
85 static int
86   IsPathDirectory(const char *);
87 
88 /*
89 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
90 %                                                                             %
91 %                                                                             %
92 %                                                                             %
93 %   A c q u i r e U n i q u e F i l e n a m e                                 %
94 %                                                                             %
95 %                                                                             %
96 %                                                                             %
97 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
98 %
99 %  AcquireUniqueFilename() replaces the contents of path by a unique path name.
100 %
101 %  The format of the AcquireUniqueFilename method is:
102 %
103 %      MagickBooleanType AcquireUniqueFilename(char *path)
104 %
105 %  A description of each parameter follows.
106 %
107 %   o  path:  Specifies a pointer to an array of characters.  The unique path
108 %      name is returned in this array.
109 %
110 */
AcquireUniqueFilename(char * path)111 MagickExport MagickBooleanType AcquireUniqueFilename(char *path)
112 {
113   int
114     file;
115 
116   file=AcquireUniqueFileResource(path);
117   if (file == -1)
118     return(MagickFalse);
119   file=close(file)-1;
120   return(MagickTrue);
121 }
122 
123 /*
124 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
125 %                                                                             %
126 %                                                                             %
127 %                                                                             %
128 %   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 %                                                                             %
130 %                                                                             %
131 %                                                                             %
132 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
133 %
134 %  AcquireUniqueSymbolicLink() creates a unique symbolic link to the specified
135 %  source path and returns MagickTrue on success otherwise MagickFalse.  If the
136 %  symlink() method fails or is not available, a unique file name is generated
137 %  and the source file copied to it.  When you are finished with the file, use
138 %  RelinquishUniqueFilename() to destroy it.
139 %
140 %  The format of the AcquireUniqueSymbolicLink method is:
141 %
142 %      MagickBooleanType AcquireUniqueSymbolicLink(const char *source,
143 %        char destination)
144 %
145 %  A description of each parameter follows.
146 %
147 %   o  source:  the source path.
148 %
149 %   o  destination:  the destination path.
150 %
151 */
152 
AcquireUniqueSymbolicLink(const char * source,char * destination)153 MagickExport MagickBooleanType AcquireUniqueSymbolicLink(const char *source,
154   char *destination)
155 {
156   int
157     destination_file,
158     source_file;
159 
160   MagickBooleanType
161     status;
162 
163   size_t
164     length,
165     quantum;
166 
167   ssize_t
168     count;
169 
170   struct stat
171     attributes;
172 
173   unsigned char
174     *buffer;
175 
176   assert(source != (const char *) NULL);
177   assert(destination != (char *) NULL);
178 #if defined(MAGICKCORE_HAVE_SYMLINK)
179   {
180     char
181       *passes;
182 
183     (void) AcquireUniqueFilename(destination);
184     (void) RelinquishUniqueFileResource(destination);
185     passes=GetPolicyValue("system:shred");
186     if (passes != (char *) NULL)
187       passes=DestroyString(passes);
188     else
189       {
190         if (*source == *DirectorySeparator)
191           {
192             if (symlink(source,destination) == 0)
193               return(MagickTrue);
194           }
195         else
196           {
197             char
198               path[MagickPathExtent];
199 
200             *path='\0';
201             if (getcwd(path,MagickPathExtent) == (char *) NULL)
202               return(MagickFalse);
203             (void) ConcatenateMagickString(path,DirectorySeparator,
204               MagickPathExtent);
205             (void) ConcatenateMagickString(path,source,MagickPathExtent);
206             if (symlink(path,destination) == 0)
207               return(MagickTrue);
208           }
209       }
210   }
211 #endif
212   destination_file=AcquireUniqueFileResource(destination);
213   if (destination_file == -1)
214     return(MagickFalse);
215   source_file=open_utf8(source,O_RDONLY | O_BINARY,0);
216   if (source_file == -1)
217     {
218       (void) close(destination_file);
219       (void) RelinquishUniqueFileResource(destination);
220       return(MagickFalse);
221     }
222   quantum=(size_t) MagickMaxBufferExtent;
223   if ((fstat(source_file,&attributes) == 0) && (attributes.st_size > 0))
224     quantum=(size_t) MagickMin(attributes.st_size,MagickMaxBufferExtent);
225   buffer=(unsigned char *) AcquireQuantumMemory(quantum,sizeof(*buffer));
226   if (buffer == (unsigned char *) NULL)
227     {
228       (void) close(source_file);
229       (void) close(destination_file);
230       (void) RelinquishUniqueFileResource(destination);
231       return(MagickFalse);
232     }
233   status=MagickTrue;
234   for (length=0; ; )
235   {
236     count=(ssize_t) read(source_file,buffer,quantum);
237     if (count <= 0)
238       break;
239     length=(size_t) count;
240     count=(ssize_t) write(destination_file,buffer,length);
241     if ((size_t) count != length)
242       {
243         (void) RelinquishUniqueFileResource(destination);
244         status=MagickFalse;
245         break;
246       }
247   }
248   (void) close(destination_file);
249   (void) close(source_file);
250   buffer=(unsigned char *) RelinquishMagickMemory(buffer);
251   return(status);
252 }
253 
254 /*
255 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
256 %                                                                             %
257 %                                                                             %
258 %                                                                             %
259 %  A p p e n d I m a g e F o r m a t                                          %
260 %                                                                             %
261 %                                                                             %
262 %                                                                             %
263 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
264 %
265 %  AppendImageFormat() appends the image format type to the filename.  If an
266 %  extension to the file already exists, it is first removed.
267 %
268 %  The format of the AppendImageFormat method is:
269 %
270 %      void AppendImageFormat(const char *format,char *filename)
271 %
272 %  A description of each parameter follows.
273 %
274 %   o  format:  Specifies a pointer to an array of characters.  This the
275 %      format of the image.
276 %
277 %   o  filename:  Specifies a pointer to an array of characters.  The unique
278 %      file name is returned in this array.
279 %
280 */
AppendImageFormat(const char * format,char * filename)281 MagickExport void AppendImageFormat(const char *format,char *filename)
282 {
283   char
284     extension[MagickPathExtent],
285     root[MagickPathExtent];
286 
287   assert(format != (char *) NULL);
288   assert(filename != (char *) NULL);
289   (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",filename);
290   if ((*format == '\0') || (*filename == '\0'))
291     return;
292   if (LocaleCompare(filename,"-") == 0)
293     {
294       char
295         message[MagickPathExtent];
296 
297       (void) FormatLocaleString(message,MagickPathExtent,"%s:%s",format,
298         filename);
299       (void) CopyMagickString(filename,message,MagickPathExtent);
300       return;
301     }
302   GetPathComponent(filename,ExtensionPath,extension);
303   if ((LocaleCompare(extension,"Z") == 0) ||
304       (LocaleCompare(extension,"bz2") == 0) ||
305       (LocaleCompare(extension,"gz") == 0) ||
306       (LocaleCompare(extension,"wmz") == 0) ||
307       (LocaleCompare(extension,"svgz") == 0))
308     {
309       GetPathComponent(filename,RootPath,root);
310       (void) CopyMagickString(filename,root,MagickPathExtent);
311       GetPathComponent(filename,RootPath,root);
312       (void) FormatLocaleString(filename,MagickPathExtent,"%s.%s.%s",root,
313         format,extension);
314       return;
315     }
316   GetPathComponent(filename,RootPath,root);
317   (void) FormatLocaleString(filename,MagickPathExtent,"%s.%s",root,format);
318 }
319 
320 /*
321 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
322 %                                                                             %
323 %                                                                             %
324 %                                                                             %
325 %   B a s e 6 4 D e c o d e                                                   %
326 %                                                                             %
327 %                                                                             %
328 %                                                                             %
329 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
330 %
331 %  Base64Decode() decodes Base64-encoded text and returns its binary
332 %  equivalent.  NULL is returned if the text is not valid Base64 data, or a
333 %  memory allocation failure occurs.
334 %
335 %  The format of the Base64Decode method is:
336 %
337 %      unsigned char *Base64Decode(const char *source,length_t *length)
338 %
339 %  A description of each parameter follows:
340 %
341 %    o source:  A pointer to a Base64-encoded string.
342 %
343 %    o length: the number of bytes decoded.
344 %
345 */
Base64Decode(const char * source,size_t * length)346 MagickExport unsigned char *Base64Decode(const char *source,size_t *length)
347 {
348   int
349     state;
350 
351   register const char
352     *p,
353     *q;
354 
355   register size_t
356     i;
357 
358   unsigned char
359     *decode;
360 
361   (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
362   assert(source != (char *) NULL);
363   assert(length != (size_t *) NULL);
364   *length=0;
365   decode=(unsigned char *) AcquireQuantumMemory((strlen(source)+3)/4,
366     3*sizeof(*decode));
367   if (decode == (unsigned char *) NULL)
368     return((unsigned char *) NULL);
369   i=0;
370   state=0;
371   for (p=source; *p != '\0'; p++)
372   {
373     if (isspace((int) ((unsigned char) *p)) != 0)
374       continue;
375     if (*p == '=')
376       break;
377     q=strchr(Base64,*p);
378     if (q == (char *) NULL)
379       {
380         decode=(unsigned char *) RelinquishMagickMemory(decode);
381         return((unsigned char *) NULL);  /* non-Base64 character */
382       }
383     switch (state)
384     {
385       case 0:
386       {
387         decode[i]=(q-Base64) << 2;
388         state++;
389         break;
390       }
391       case 1:
392       {
393         decode[i++]|=(q-Base64) >> 4;
394         decode[i]=((q-Base64) & 0x0f) << 4;
395         state++;
396         break;
397       }
398       case 2:
399       {
400         decode[i++]|=(q-Base64) >> 2;
401         decode[i]=((q-Base64) & 0x03) << 6;
402         state++;
403         break;
404       }
405       case 3:
406       {
407         decode[i++]|=(q-Base64);
408         state=0;
409         break;
410       }
411     }
412   }
413   /*
414     Verify Base-64 string has proper terminal characters.
415   */
416   if (*p != '=')
417     {
418       if (state != 0)
419         {
420           decode=(unsigned char *) RelinquishMagickMemory(decode);
421           return((unsigned char *) NULL);
422         }
423     }
424   else
425     {
426       p++;
427       switch (state)
428       {
429         case 0:
430         case 1:
431         {
432           /*
433             Unrecognized '=' character.
434           */
435           decode=(unsigned char *) RelinquishMagickMemory(decode);
436           return((unsigned char *) NULL);
437         }
438         case 2:
439         {
440           for ( ; *p != '\0'; p++)
441             if (isspace((int) ((unsigned char) *p)) == 0)
442               break;
443           if (*p != '=')
444             {
445               decode=(unsigned char *) RelinquishMagickMemory(decode);
446               return((unsigned char *) NULL);
447             }
448           p++;
449         }
450         case 3:
451         {
452           for ( ; *p != '\0'; p++)
453             if (isspace((int) ((unsigned char) *p)) == 0)
454               {
455                 decode=(unsigned char *) RelinquishMagickMemory(decode);
456                 return((unsigned char *) NULL);
457               }
458           if ((int) decode[i] != 0)
459             {
460               decode=(unsigned char *) RelinquishMagickMemory(decode);
461               return((unsigned char *) NULL);
462             }
463           break;
464         }
465       }
466     }
467   *length=i;
468   return(decode);
469 }
470 
471 /*
472 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
473 %                                                                             %
474 %                                                                             %
475 %                                                                             %
476 %   B a s e 6 4 E n c o d e                                                   %
477 %                                                                             %
478 %                                                                             %
479 %                                                                             %
480 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
481 %
482 %  Base64Encode() encodes arbitrary binary data to Base64 encoded format as
483 %  described by the "Base64 Content-Transfer-Encoding" section of RFC 2045 and
484 %  returns the result as a null-terminated ASCII string.  NULL is returned if
485 %  a memory allocation failure occurs.
486 %
487 %  The format of the Base64Encode method is:
488 %
489 %      char *Base64Encode(const unsigned char *blob,const size_t blob_length,
490 %        size_t *encode_length)
491 %
492 %  A description of each parameter follows:
493 %
494 %    o blob:  A pointer to binary data to encode.
495 %
496 %    o blob_length: the number of bytes to encode.
497 %
498 %    o encode_length:  The number of bytes encoded.
499 %
500 */
Base64Encode(const unsigned char * blob,const size_t blob_length,size_t * encode_length)501 MagickExport char *Base64Encode(const unsigned char *blob,
502   const size_t blob_length,size_t *encode_length)
503 {
504   char
505     *encode;
506 
507   register const unsigned char
508     *p;
509 
510   register size_t
511     i;
512 
513   size_t
514     remainder;
515 
516   (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
517   assert(blob != (const unsigned char *) NULL);
518   assert(blob_length != 0);
519   assert(encode_length != (size_t *) NULL);
520   *encode_length=0;
521   encode=(char *) AcquireQuantumMemory(blob_length/3+4,4*sizeof(*encode));
522   if (encode == (char *) NULL)
523     return((char *) NULL);
524   i=0;
525   for (p=blob; p < (blob+blob_length-2); p+=3)
526   {
527     encode[i++]=Base64[(int) (*p >> 2)];
528     encode[i++]=Base64[(int) (((*p & 0x03) << 4)+(*(p+1) >> 4))];
529     encode[i++]=Base64[(int) (((*(p+1) & 0x0f) << 2)+(*(p+2) >> 6))];
530     encode[i++]=Base64[(int) (*(p+2) & 0x3f)];
531   }
532   remainder=blob_length % 3;
533   if (remainder != 0)
534     {
535       ssize_t
536         j;
537 
538       unsigned char
539         code[3];
540 
541       code[0]='\0';
542       code[1]='\0';
543       code[2]='\0';
544       for (j=0; j < (ssize_t) remainder; j++)
545         code[j]=(*p++);
546       encode[i++]=Base64[(int) (code[0] >> 2)];
547       encode[i++]=Base64[(int) (((code[0] & 0x03) << 4)+(code[1] >> 4))];
548       if (remainder == 1)
549         encode[i++]='=';
550       else
551         encode[i++]=Base64[(int) (((code[1] & 0x0f) << 2)+(code[2] >> 6))];
552       encode[i++]='=';
553     }
554   *encode_length=i;
555   encode[i++]='\0';
556   return(encode);
557 }
558 
559 /*
560 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
561 %                                                                             %
562 %                                                                             %
563 %                                                                             %
564 %   C h o p P a t h C o m p o n e n t s                                       %
565 %                                                                             %
566 %                                                                             %
567 %                                                                             %
568 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
569 %
570 %  ChopPathComponents() removes the number of specified file components from a
571 %  path.
572 %
573 %  The format of the ChopPathComponents method is:
574 %
575 %      ChopPathComponents(char *path,size_t components)
576 %
577 %  A description of each parameter follows:
578 %
579 %    o path:  The path.
580 %
581 %    o components:  The number of components to chop.
582 %
583 */
ChopPathComponents(char * path,const size_t components)584 MagickPrivate void ChopPathComponents(char *path,const size_t components)
585 {
586   register ssize_t
587     i;
588 
589   for (i=0; i < (ssize_t) components; i++)
590     GetPathComponent(path,HeadPath,path);
591 }
592 
593 /*
594 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
595 %                                                                             %
596 %                                                                             %
597 %                                                                             %
598 %   E x p a n d F i l e n a m e                                               %
599 %                                                                             %
600 %                                                                             %
601 %                                                                             %
602 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
603 %
604 %  ExpandFilename() expands '~' in a path.
605 %
606 %  The format of the ExpandFilename function is:
607 %
608 %      ExpandFilename(char *path)
609 %
610 %  A description of each parameter follows:
611 %
612 %    o path: Specifies a pointer to a character array that contains the
613 %      path.
614 %
615 */
ExpandFilename(char * path)616 MagickPrivate void ExpandFilename(char *path)
617 {
618   char
619     expand_path[MagickPathExtent];
620 
621   if (path == (char *) NULL)
622     return;
623   if (*path != '~')
624     return;
625   (void) CopyMagickString(expand_path,path,MagickPathExtent);
626   if ((*(path+1) == *DirectorySeparator) || (*(path+1) == '\0'))
627     {
628       char
629         *home;
630 
631       /*
632         Substitute ~ with $HOME.
633       */
634       (void) CopyMagickString(expand_path,".",MagickPathExtent);
635       (void) ConcatenateMagickString(expand_path,path+1,MagickPathExtent);
636       home=GetEnvironmentValue("HOME");
637       if (home == (char *) NULL)
638         home=GetEnvironmentValue("USERPROFILE");
639       if (home != (char *) NULL)
640         {
641           (void) CopyMagickString(expand_path,home,MagickPathExtent);
642           (void) ConcatenateMagickString(expand_path,path+1,MagickPathExtent);
643           home=DestroyString(home);
644         }
645     }
646   else
647     {
648 #if defined(MAGICKCORE_POSIX_SUPPORT) && !defined(__OS2__)
649       char
650 #if defined(MAGICKCORE_HAVE_GETPWNAM_R)
651         buffer[MagickPathExtent],
652 #endif
653         username[MagickPathExtent];
654 
655       register char
656         *p;
657 
658       struct passwd
659         *entry;
660 
661       /*
662         Substitute ~ with home directory from password file.
663       */
664       (void) CopyMagickString(username,path+1,MagickPathExtent);
665       p=strchr(username,'/');
666       if (p != (char *) NULL)
667         *p='\0';
668 #if !defined(MAGICKCORE_HAVE_GETPWNAM_R)
669       entry=getpwnam(username);
670 #else
671       struct passwd
672         pwd;
673 
674       entry=(struct passwd *) NULL;
675       if (getpwnam_r(username,&pwd,buffer,sizeof(buffer),&entry) < 0)
676         return;
677 #endif
678       if (entry == (struct passwd *) NULL)
679         return;
680       (void) CopyMagickString(expand_path,entry->pw_dir,MagickPathExtent);
681       if (p != (char *) NULL)
682         {
683           (void) ConcatenateMagickString(expand_path,"/",MagickPathExtent);
684           (void) ConcatenateMagickString(expand_path,p+1,MagickPathExtent);
685         }
686 #endif
687     }
688   (void) CopyMagickString(path,expand_path,MagickPathExtent);
689 }
690 
691 /*
692 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
693 %                                                                             %
694 %                                                                             %
695 %                                                                             %
696 %   E x p a n d F i l e n a m e s                                             %
697 %                                                                             %
698 %                                                                             %
699 %                                                                             %
700 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
701 %
702 %  ExpandFilenames() checks each argument of the given argument array, and
703 %  expands it if they have a wildcard character.
704 %
705 %  Any coder prefix (EG: 'coder:filename') or read modifier postfix (EG:
706 %  'filename[...]') are ignored during the file the expansion, but will be
707 %  included in the final argument.  If no filename matching the meta-character
708 %  'glob' is found the original argument is returned.
709 %
710 %  For example, an argument of '*.gif[20x20]' will be replaced by the list
711 %    'abc.gif[20x20]',  'foobar.gif[20x20]',  'xyzzy.gif[20x20]'
712 %  if such filenames exist, (in the current directory in this case).
713 %
714 %  Meta-characters handled...
715 %     @    read a list of filenames (no further expansion performed)
716 %     ~    At start of filename expands to HOME environemtn variable
717 %     *    matches any string including an empty string
718 %     ?    matches by any single character
719 %
720 %  WARNING: filenames starting with '.' (hidden files in a UNIX file system)
721 %  will never be expanded.  Attempting to epand '.*' will produce no change.
722 %
723 %  Expansion is ignored for coders "label:" "caption:" "pango:" and "vid:".
724 %  Which provide their own '@' meta-character handling.
725 %
726 %  You can see the results of the expansion using "Configure" log events.
727 %
728 %  The returned list should be freed using  DestroyStringList().
729 %
730 %  However the strings in the original pointed to argv are not
731 %  freed  (TO BE CHECKED).  So a copy of the original pointer (and count)
732 %  should be kept separate if they need to be freed later.
733 %
734 %  The format of the ExpandFilenames function is:
735 %
736 %      status=ExpandFilenames(int *number_arguments,char ***arguments)
737 %
738 %  A description of each parameter follows:
739 %
740 %    o number_arguments: Specifies a pointer to an integer describing the
741 %      number of elements in the argument vector.
742 %
743 %    o arguments: Specifies a pointer to a text array containing the command
744 %      line arguments.
745 %
746 */
ExpandFilenames(int * number_arguments,char *** arguments)747 MagickExport MagickBooleanType ExpandFilenames(int *number_arguments,
748   char ***arguments)
749 {
750   char
751     home_directory[MagickPathExtent],
752     **vector;
753 
754   register ssize_t
755     i,
756     j;
757 
758   size_t
759     number_files;
760 
761   ssize_t
762     count,
763     parameters;
764 
765   /*
766     Allocate argument vector.
767   */
768   (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
769   assert(number_arguments != (int *) NULL);
770   assert(arguments != (char ***) NULL);
771   vector=(char **) AcquireQuantumMemory((size_t) (*number_arguments+1),
772     sizeof(*vector));
773   if (vector == (char **) NULL)
774     ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
775   /*
776     Expand any wildcard filenames.
777   */
778   *home_directory='\0';
779   count=0;
780   for (i=0; i < (ssize_t) *number_arguments; i++)
781   {
782     char
783       **filelist,
784       filename[MagickPathExtent],
785       magick[MagickPathExtent],
786       *option,
787       path[MagickPathExtent],
788       subimage[MagickPathExtent];
789 
790     MagickBooleanType
791       destroy;
792 
793     option=(*arguments)[i];
794     *magick='\0';
795     *path='\0';
796     *filename='\0';
797     *subimage='\0';
798     number_files=0;
799     vector[count++]=ConstantString(option);
800     destroy=MagickTrue;
801     parameters=ParseCommandOption(MagickCommandOptions,MagickFalse,option);
802     if (parameters > 0)
803       {
804         /*
805           Do not expand command option parameters.
806         */
807         for (j=0; j < parameters; j++)
808         {
809           i++;
810           if (i == (ssize_t) *number_arguments)
811             break;
812           option=(*arguments)[i];
813           vector[count++]=ConstantString(option);
814         }
815         continue;
816       }
817     if ((*option == '"') || (*option == '\''))
818       continue;
819     GetPathComponent(option,TailPath,filename);
820     GetPathComponent(option,MagickPath,magick);
821     if ((LocaleCompare(magick,"CAPTION") == 0) ||
822         (LocaleCompare(magick,"LABEL") == 0) ||
823         (LocaleCompare(magick,"PANGO") == 0) ||
824         (LocaleCompare(magick,"VID") == 0))
825       continue;
826     if ((IsGlob(filename) == MagickFalse) && (*option != '@'))
827       continue;
828     if ((*option != '@') && (IsPathAccessible(option) == MagickFalse))
829       {
830         /*
831           Generate file list from wildcard filename (e.g. *.jpg).
832         */
833         GetPathComponent(option,HeadPath,path);
834         GetPathComponent(option,SubimagePath,subimage);
835         ExpandFilename(path);
836         if (*home_directory == '\0')
837           getcwd_utf8(home_directory,MagickPathExtent-1);
838         filelist=ListFiles(*path == '\0' ? home_directory : path,filename,
839           &number_files);
840       }
841     else
842       {
843         char
844           *files;
845 
846         ExceptionInfo
847           *exception;
848 
849         int
850           length;
851 
852         /*
853           Generate file list from file list (e.g. @filelist.txt).
854         */
855         exception=AcquireExceptionInfo();
856         files=FileToString(option+1,~0UL,exception);
857         exception=DestroyExceptionInfo(exception);
858         if (files == (char *) NULL)
859           continue;
860         filelist=StringToArgv(files,&length);
861         if (filelist == (char **) NULL)
862           continue;
863         files=DestroyString(files);
864         filelist[0]=DestroyString(filelist[0]);
865         for (j=0; j < (ssize_t) (length-1); j++)
866           filelist[j]=filelist[j+1];
867         number_files=(size_t) length-1;
868       }
869     if (filelist == (char **) NULL)
870       continue;
871     for (j=0; j < (ssize_t) number_files; j++)
872       if (IsPathDirectory(filelist[j]) <= 0)
873         break;
874     if (j == (ssize_t) number_files)
875       {
876         for (j=0; j < (ssize_t) number_files; j++)
877           filelist[j]=DestroyString(filelist[j]);
878         filelist=(char **) RelinquishMagickMemory(filelist);
879         continue;
880       }
881     /*
882       Transfer file list to argument vector.
883     */
884     vector=(char **) ResizeQuantumMemory(vector,(size_t) *number_arguments+
885       count+number_files+1,sizeof(*vector));
886     if (vector == (char **) NULL)
887       {
888         for (j=0; j < (ssize_t) number_files; j++)
889           filelist[j]=DestroyString(filelist[j]);
890         filelist=(char **) RelinquishMagickMemory(filelist);
891         return(MagickFalse);
892       }
893     for (j=0; j < (ssize_t) number_files; j++)
894     {
895       option=filelist[j];
896       parameters=ParseCommandOption(MagickCommandOptions,MagickFalse,option);
897       if (parameters > 0)
898         {
899           ssize_t
900             k;
901 
902           /*
903             Do not expand command option parameters.
904           */
905           vector[count++]=ConstantString(option);
906           for (k=0; k < parameters; k++)
907           {
908             j++;
909             if (j == (ssize_t) number_files)
910               break;
911             option=filelist[j];
912             vector[count++]=ConstantString(option);
913           }
914           continue;
915         }
916       (void) CopyMagickString(filename,path,MagickPathExtent);
917       if (*path != '\0')
918         (void) ConcatenateMagickString(filename,DirectorySeparator,
919           MagickPathExtent);
920       if (filelist[j] != (char *) NULL)
921         (void) ConcatenateMagickString(filename,filelist[j],MagickPathExtent);
922       filelist[j]=DestroyString(filelist[j]);
923       if (strlen(filename) >= (MagickPathExtent-1))
924         ThrowFatalException(OptionFatalError,"FilenameTruncated");
925       if (IsPathDirectory(filename) <= 0)
926         {
927           char
928             file_path[MagickPathExtent];
929 
930           *file_path='\0';
931           if (*magick != '\0')
932             {
933               (void) ConcatenateMagickString(file_path,magick,
934                 MagickPathExtent);
935               (void) ConcatenateMagickString(file_path,":",MagickPathExtent);
936             }
937           (void) ConcatenateMagickString(file_path,filename,MagickPathExtent);
938           if (*subimage != '\0')
939             {
940               (void) ConcatenateMagickString(file_path,"[",MagickPathExtent);
941               (void) ConcatenateMagickString(file_path,subimage,
942                 MagickPathExtent);
943               (void) ConcatenateMagickString(file_path,"]",MagickPathExtent);
944             }
945           if (strlen(file_path) >= (MagickPathExtent-1))
946             ThrowFatalException(OptionFatalError,"FilenameTruncated");
947           if (destroy != MagickFalse)
948             {
949               count--;
950               vector[count]=DestroyString(vector[count]);
951               destroy=MagickFalse;
952             }
953           vector[count++]=ConstantString(file_path);
954         }
955     }
956     filelist=(char **) RelinquishMagickMemory(filelist);
957   }
958   vector[count]=(char *) NULL;
959   if (IsEventLogging() != MagickFalse)
960     {
961       char
962         *command_line;
963 
964       command_line=AcquireString(vector[0]);
965       for (i=1; i < count; i++)
966       {
967         (void) ConcatenateString(&command_line," {");
968         (void) ConcatenateString(&command_line,vector[i]);
969         (void) ConcatenateString(&command_line,"}");
970       }
971       (void) LogMagickEvent(ConfigureEvent,GetMagickModule(),
972         "Command line: %s",command_line);
973       command_line=DestroyString(command_line);
974     }
975   *number_arguments=(int) count;
976   *arguments=vector;
977   return(MagickTrue);
978 }
979 
980 /*
981 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
982 %                                                                             %
983 %                                                                             %
984 %                                                                             %
985 %   G e t E x e c u t i o n P a t h                                           %
986 %                                                                             %
987 %                                                                             %
988 %                                                                             %
989 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
990 %
991 %  GetExecutionPath() returns the pathname of the executable that started
992 %  the process.  On success MagickTrue is returned, otherwise MagickFalse.
993 %
994 %  The format of the GetExecutionPath method is:
995 %
996 %      MagickBooleanType GetExecutionPath(char *path,const size_t extent)
997 %
998 %  A description of each parameter follows:
999 %
1000 %    o path: the pathname of the executable that started the process.
1001 %
1002 %    o extent: the maximum extent of the path.
1003 %
1004 */
GetExecutionPath(char * path,const size_t extent)1005 MagickPrivate MagickBooleanType GetExecutionPath(char *path,const size_t extent)
1006 {
1007   char
1008     *directory;
1009 
1010   *path='\0';
1011   directory=getcwd(path,(unsigned long) extent);
1012   (void) directory;
1013 #if defined(MAGICKCORE_HAVE_GETPID) && defined(MAGICKCORE_HAVE_READLINK) && defined(PATH_MAX)
1014   {
1015     char
1016       execution_path[PATH_MAX+1],
1017       link_path[MagickPathExtent];
1018 
1019     ssize_t
1020       count;
1021 
1022     (void) FormatLocaleString(link_path,MagickPathExtent,"/proc/%.20g/exe",
1023       (double) getpid());
1024     count=readlink(link_path,execution_path,PATH_MAX);
1025     if (count == -1)
1026       {
1027         (void) FormatLocaleString(link_path,MagickPathExtent,"/proc/%.20g/file",
1028           (double) getpid());
1029         count=readlink(link_path,execution_path,PATH_MAX);
1030       }
1031     if ((count > 0) && (count <= (ssize_t) PATH_MAX))
1032       {
1033         execution_path[count]='\0';
1034         (void) CopyMagickString(path,execution_path,extent);
1035       }
1036   }
1037 #endif
1038 #if defined(MAGICKCORE_HAVE__NSGETEXECUTABLEPATH)
1039   {
1040     char
1041       executable_path[PATH_MAX << 1],
1042       execution_path[PATH_MAX+1];
1043 
1044     uint32_t
1045       length;
1046 
1047     length=sizeof(executable_path);
1048     if ((_NSGetExecutablePath(executable_path,&length) == 0) &&
1049         (realpath(executable_path,execution_path) != (char *) NULL))
1050       (void) CopyMagickString(path,execution_path,extent);
1051   }
1052 #endif
1053 #if defined(MAGICKCORE_HAVE_GETEXECNAME)
1054   {
1055     const char
1056       *execution_path;
1057 
1058     execution_path=(const char *) getexecname();
1059     if (execution_path != (const char *) NULL)
1060       {
1061         if (*execution_path != *DirectorySeparator)
1062           (void) ConcatenateMagickString(path,DirectorySeparator,extent);
1063         (void) ConcatenateMagickString(path,execution_path,extent);
1064       }
1065   }
1066 #endif
1067 #if defined(MAGICKCORE_WINDOWS_SUPPORT)
1068   NTGetExecutionPath(path,extent);
1069 #endif
1070 #if defined(__GNU__)
1071   {
1072     char
1073       *program_name;
1074 
1075     ssize_t
1076       count;
1077 
1078     count=0;
1079     program_name=program_invocation_name;
1080     if (*program_invocation_name != '/')
1081       {
1082         size_t
1083           extent;
1084 
1085         extent=strlen(directory)+strlen(program_name)+2;
1086         program_name=AcquireQuantumMemory(extent,sizeof(*program_name));
1087         if (program_name == (char *) NULL)
1088           program_name=program_invocation_name;
1089         else
1090           count=FormatLocaleString(program_name,extent,"%s/%s",directory,
1091             program_invocation_name);
1092       }
1093     if (count != -1)
1094       {
1095         char
1096           execution_path[PATH_MAX+1];
1097 
1098         if (realpath(program_name,execution_path) != (char *) NULL)
1099           (void) CopyMagickString(path,execution_path,extent);
1100       }
1101     if (program_name != program_invocation_name)
1102       program_name=(char *) RelinquishMagickMemory(program_name);
1103   }
1104 #endif
1105 #if defined(__OpenBSD__)
1106   {
1107     extern char
1108       *__progname;
1109 
1110     (void) CopyMagickString(path,__progname,extent);
1111   }
1112 #endif
1113   return(IsPathAccessible(path));
1114 }
1115 
1116 /*
1117 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1118 %                                                                             %
1119 %                                                                             %
1120 %                                                                             %
1121 %   G e t M a g i c k P a g e S i z e                                         %
1122 %                                                                             %
1123 %                                                                             %
1124 %                                                                             %
1125 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1126 %
1127 %  GetMagickPageSize() returns the memory page size.
1128 %
1129 %  The format of the GetMagickPageSize method is:
1130 %
1131 %      ssize_t GetMagickPageSize()
1132 %
1133 */
GetMagickPageSize(void)1134 MagickPrivate ssize_t GetMagickPageSize(void)
1135 {
1136   static ssize_t
1137     page_size = -1;
1138 
1139   if (page_size > 0)
1140     return(page_size);
1141 #if defined(MAGICKCORE_HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)
1142   page_size=(ssize_t) sysconf(_SC_PAGE_SIZE);
1143 #elif defined(MAGICKCORE_HAVE_GETPAGESIZE)
1144   page_size=(ssize_t) getpagesize();
1145 #elif defined(MAGICKCORE_WINDOWS_SUPPORT)
1146   page_size=NTGetPageSize();
1147 #endif
1148   if (page_size <= 0)
1149     page_size=4096;
1150   return(page_size);
1151 }
1152 
1153 /*
1154 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1155 %                                                                             %
1156 %                                                                             %
1157 %                                                                             %
1158 %   G e t P a t h A t t r i b u t e s                                         %
1159 %                                                                             %
1160 %                                                                             %
1161 %                                                                             %
1162 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1163 %
1164 %  GetPathAttributes() returns attributes (e.g. size of file) about a path.
1165 %
1166 %  The path of the GetPathAttributes method is:
1167 %
1168 %      MagickBooleanType GetPathAttributes(const char *path,void *attributes)
1169 %
1170 %  A description of each parameter follows.
1171 %
1172 %   o  path: the file path.
1173 %
1174 %   o  attributes: the path attributes are returned here.
1175 %
1176 */
GetPathAttributes(const char * path,void * attributes)1177 MagickExport MagickBooleanType GetPathAttributes(const char *path,
1178   void *attributes)
1179 {
1180   MagickBooleanType
1181     status;
1182 
1183   if (path == (const char *) NULL)
1184     {
1185       errno=EINVAL;
1186       return(MagickFalse);
1187     }
1188   (void) memset(attributes,0,sizeof(struct stat));
1189   status=stat_utf8(path,(struct stat *) attributes) == 0 ? MagickTrue :
1190     MagickFalse;
1191   return(status);
1192 }
1193 
1194 /*
1195 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1196 %                                                                             %
1197 %                                                                             %
1198 %                                                                             %
1199 %   G e t P a t h C o m p o n e n t                                           %
1200 %                                                                             %
1201 %                                                                             %
1202 %                                                                             %
1203 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1204 %
1205 %  GetPathComponent() returns the parent directory name, filename, basename, or
1206 %  extension of a file path.
1207 %
1208 %  The component string pointed to must have at least MagickPathExtent space
1209 %  for the results to be stored.
1210 %
1211 %  The format of the GetPathComponent function is:
1212 %
1213 %      GetPathComponent(const char *path,PathType type,char *component)
1214 %
1215 %  A description of each parameter follows:
1216 %
1217 %    o path: Specifies a pointer to a character array that contains the
1218 %      file path.
1219 %
1220 %    o type: Specififies which file path component to return.
1221 %
1222 %    o component: the selected file path component is returned here.
1223 %
1224 */
GetPathComponent(const char * path,PathType type,char * component)1225 MagickExport void GetPathComponent(const char *path,PathType type,
1226   char *component)
1227 {
1228   char
1229     *q;
1230 
1231   register char
1232     *p;
1233 
1234   size_t
1235     magick_length,
1236     subimage_offset,
1237     subimage_length;
1238 
1239   assert(path != (const char *) NULL);
1240   (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",path);
1241   assert(component != (char *) NULL);
1242   if (*path == '\0')
1243     {
1244       *component='\0';
1245       return;
1246     }
1247   (void) CopyMagickString(component,path,MagickPathExtent);
1248   subimage_length=0;
1249   subimage_offset=0;
1250   if (type != SubcanonicalPath)
1251     {
1252       p=component+strlen(component)-1;
1253       if ((strlen(component) > 2) && (*p == ']'))
1254         {
1255           q=strrchr(component,'[');
1256           if ((q != (char *) NULL) && ((q == component) || (*(q-1) != ']')) &&
1257               (IsPathAccessible(path) == MagickFalse))
1258             {
1259               /*
1260                 Look for scene specification (e.g. img0001.pcd[4]).
1261               */
1262               *p='\0';
1263               if ((IsSceneGeometry(q+1,MagickFalse) == MagickFalse) &&
1264                   (IsGeometry(q+1) == MagickFalse))
1265                 *p=']';
1266               else
1267                 {
1268                   subimage_length=(size_t) (p-q);
1269                   subimage_offset=(size_t) (q-component+1);
1270                   *q='\0';
1271                 }
1272             }
1273         }
1274     }
1275   magick_length=0;
1276 #if defined(__OS2__)
1277   if (path[1] != ":")
1278 #endif
1279   for (p=component; *p != '\0'; p++)
1280   {
1281     if ((*p == '%') && (*(p+1) == '['))
1282       {
1283         /*
1284           Skip over %[...].
1285         */
1286         for (p++; (*p != ']') && (*p != '\0'); p++) ;
1287         if (*p == '\0')
1288           break;
1289       }
1290     if ((p != component) && (*p == ':') && (IsPathDirectory(component) < 0) &&
1291         (IsPathAccessible(component) == MagickFalse))
1292       {
1293         /*
1294           Look for image format specification (e.g. ps3:image).
1295         */
1296         *p='\0';
1297         if (IsMagickConflict(component) != MagickFalse)
1298           *p=':';
1299         else
1300           {
1301             magick_length=(size_t) (p-component+1);
1302             for (q=component; *(++p) != '\0'; q++)
1303               *q=(*p);
1304             *q='\0';
1305           }
1306         break;
1307       }
1308   }
1309   p=component;
1310   if (*p != '\0')
1311     for (p=component+strlen(component)-1; p > component; p--)
1312       if (IsBasenameSeparator(*p) != MagickFalse)
1313         break;
1314   switch (type)
1315   {
1316     case MagickPath:
1317     {
1318       if (magick_length != 0)
1319         (void) CopyMagickString(component,path,magick_length);
1320       else
1321         *component='\0';
1322       break;
1323     }
1324     case RootPath:
1325     {
1326       if (*component != '\0')
1327         {
1328           for (p=component+(strlen(component)-1); p > component; p--)
1329           {
1330             if (IsBasenameSeparator(*p) != MagickFalse)
1331               break;
1332             if (*p == '.')
1333               break;
1334           }
1335           if (*p == '.')
1336             *p='\0';
1337           break;
1338         }
1339     }
1340     case HeadPath:
1341     {
1342       *p='\0';
1343       break;
1344     }
1345     case TailPath:
1346     {
1347       if (IsBasenameSeparator(*p) != MagickFalse)
1348         (void) CopyMagickString(component,p+1,MagickPathExtent);
1349       break;
1350     }
1351     case BasePath:
1352     {
1353       if (IsBasenameSeparator(*p) != MagickFalse)
1354         (void) CopyMagickString(component,p+1,MagickPathExtent);
1355       if (*component != '\0')
1356         for (p=component+(strlen(component)-1); p > component; p--)
1357           if (*p == '.')
1358             {
1359               *p='\0';
1360               break;
1361             }
1362       break;
1363     }
1364     case ExtensionPath:
1365     {
1366       if (IsBasenameSeparator(*p) != MagickFalse)
1367         (void) CopyMagickString(component,p+1,MagickPathExtent);
1368       if (*component != '\0')
1369         for (p=component+strlen(component)-1; p > component; p--)
1370           if (*p == '.')
1371             break;
1372       *component='\0';
1373       if (*p == '.')
1374         (void) CopyMagickString(component,p+1,MagickPathExtent);
1375       break;
1376     }
1377     case SubimagePath:
1378     {
1379       *component='\0';
1380       if ((subimage_length != 0) && (magick_length < subimage_offset))
1381         (void) CopyMagickString(component,path+subimage_offset,subimage_length);
1382       break;
1383     }
1384     case SubcanonicalPath:
1385     case CanonicalPath:
1386     case UndefinedPath:
1387       break;
1388   }
1389 }
1390 
1391 /*
1392 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1393 %                                                                             %
1394 %                                                                             %
1395 %                                                                             %
1396 %  G e t P a t h C o m p o n e n t s                                          %
1397 %                                                                             %
1398 %                                                                             %
1399 %                                                                             %
1400 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1401 %
1402 %  GetPathComponents() returns a list of path components.
1403 %
1404 %  The format of the GetPathComponents method is:
1405 %
1406 %      char **GetPathComponents(const char *path,
1407 %        size_t *number_componenets)
1408 %
1409 %  A description of each parameter follows:
1410 %
1411 %    o path:  Specifies the string to segment into a list.
1412 %
1413 %    o number_components:  return the number of components in the list
1414 %
1415 */
GetPathComponents(const char * path,size_t * number_components)1416 MagickPrivate char **GetPathComponents(const char *path,
1417   size_t *number_components)
1418 {
1419   char
1420     **components;
1421 
1422   register const char
1423     *p,
1424     *q;
1425 
1426   register ssize_t
1427     i;
1428 
1429   if (path == (char *) NULL)
1430     return((char **) NULL);
1431   *number_components=1;
1432   for (p=path; *p != '\0'; p++)
1433     if (IsBasenameSeparator(*p))
1434       (*number_components)++;
1435   components=(char **) AcquireQuantumMemory((size_t) *number_components+1UL,
1436     sizeof(*components));
1437   if (components == (char **) NULL)
1438     ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1439   p=path;
1440   for (i=0; i < (ssize_t) *number_components; i++)
1441   {
1442     for (q=p; *q != '\0'; q++)
1443       if (IsBasenameSeparator(*q))
1444         break;
1445     components[i]=(char *) AcquireQuantumMemory((size_t) (q-p)+MagickPathExtent,
1446       sizeof(**components));
1447     if (components[i] == (char *) NULL)
1448       ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1449     (void) CopyMagickString(components[i],p,(size_t) (q-p+1));
1450     p=q+1;
1451   }
1452   components[i]=(char *) NULL;
1453   return(components);
1454 }
1455 
1456 /*
1457 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1458 %                                                                             %
1459 %                                                                             %
1460 %                                                                             %
1461 %  I s P a t h A c c e s s i b l e                                            %
1462 %                                                                             %
1463 %                                                                             %
1464 %                                                                             %
1465 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1466 %
1467 %  IsPathAccessible() returns MagickTrue if the file as defined by the path is
1468 %  accessible.
1469 %
1470 %  The format of the IsPathAccessible method is:
1471 %
1472 %      MagickBooleanType IsPathAccessible(const char *path)
1473 %
1474 %  A description of each parameter follows.
1475 %
1476 %    o path:  Specifies a path to a file.
1477 %
1478 */
IsPathAccessible(const char * path)1479 MagickExport MagickBooleanType IsPathAccessible(const char *path)
1480 {
1481   MagickBooleanType
1482     status;
1483 
1484   struct stat
1485     attributes;
1486 
1487   if ((path == (const char *) NULL) || (*path == '\0'))
1488     return(MagickFalse);
1489   if (LocaleCompare(path,"-") == 0)
1490     return(MagickTrue);
1491   status=GetPathAttributes(path,&attributes);
1492   if (status == MagickFalse)
1493     return(status);
1494   if (S_ISREG(attributes.st_mode) == 0)
1495     return(MagickFalse);
1496   if (access_utf8(path,F_OK) != 0)
1497     return(MagickFalse);
1498   return(MagickTrue);
1499 }
1500 
1501 /*
1502 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1503 %                                                                             %
1504 %                                                                             %
1505 %                                                                             %
1506 +  I s P a t h D i r e c t o r y                                              %
1507 %                                                                             %
1508 %                                                                             %
1509 %                                                                             %
1510 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1511 %
1512 %  IsPathDirectory() returns -1 if the directory does not exist,  1 is returned
1513 %  if the path represents a directory otherwise 0.
1514 %
1515 %  The format of the IsPathDirectory method is:
1516 %
1517 %      int IsPathDirectory(const char *path)
1518 %
1519 %  A description of each parameter follows.
1520 %
1521 %   o  path:  The directory path.
1522 %
1523 */
IsPathDirectory(const char * path)1524 static int IsPathDirectory(const char *path)
1525 {
1526   MagickBooleanType
1527     status;
1528 
1529   struct stat
1530     attributes;
1531 
1532   if ((path == (const char *) NULL) || (*path == '\0'))
1533     return(MagickFalse);
1534   status=GetPathAttributes(path,&attributes);
1535   if (status == MagickFalse)
1536     return(-1);
1537   if (S_ISDIR(attributes.st_mode) == 0)
1538     return(0);
1539   return(1);
1540 }
1541 
1542 /*
1543 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1544 %                                                                             %
1545 %                                                                             %
1546 %                                                                             %
1547 %   L i s t F i l e s                                                         %
1548 %                                                                             %
1549 %                                                                             %
1550 %                                                                             %
1551 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1552 %
1553 %  ListFiles() reads the directory specified and returns a list of filenames
1554 %  contained in the directory sorted in ascending alphabetic order.
1555 %
1556 %  The format of the ListFiles function is:
1557 %
1558 %      char **ListFiles(const char *directory,const char *pattern,
1559 %        ssize_t *number_entries)
1560 %
1561 %  A description of each parameter follows:
1562 %
1563 %    o filelist: Method ListFiles returns a list of filenames contained
1564 %      in the directory.  If the directory specified cannot be read or it is
1565 %      a file a NULL list is returned.
1566 %
1567 %    o directory: Specifies a pointer to a text string containing a directory
1568 %      name.
1569 %
1570 %    o pattern: Specifies a pointer to a text string containing a pattern.
1571 %
1572 %    o number_entries:  This integer returns the number of filenames in the
1573 %      list.
1574 %
1575 */
1576 
1577 #if defined(__cplusplus) || defined(c_plusplus)
1578 extern "C" {
1579 #endif
1580 
FileCompare(const void * x,const void * y)1581 static int FileCompare(const void *x,const void *y)
1582 {
1583   register const char
1584     **p,
1585     **q;
1586 
1587   p=(const char **) x;
1588   q=(const char **) y;
1589   return(LocaleCompare(*p,*q));
1590 }
1591 
1592 #if defined(__cplusplus) || defined(c_plusplus)
1593 }
1594 #endif
1595 
ListFiles(const char * directory,const char * pattern,size_t * number_entries)1596 MagickPrivate char **ListFiles(const char *directory,const char *pattern,
1597   size_t *number_entries)
1598 {
1599   char
1600     **filelist;
1601 
1602   DIR
1603     *current_directory;
1604 
1605   struct dirent
1606     *buffer,
1607     *entry;
1608 
1609   size_t
1610     max_entries;
1611 
1612   /*
1613     Open directory.
1614   */
1615   assert(directory != (const char *) NULL);
1616   (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",directory);
1617   assert(pattern != (const char *) NULL);
1618   assert(number_entries != (size_t *) NULL);
1619   *number_entries=0;
1620   current_directory=opendir(directory);
1621   if (current_directory == (DIR *) NULL)
1622     return((char **) NULL);
1623   /*
1624     Allocate filelist.
1625   */
1626   max_entries=2048;
1627   filelist=(char **) AcquireQuantumMemory((size_t) max_entries,
1628     sizeof(*filelist));
1629   if (filelist == (char **) NULL)
1630     {
1631       (void) closedir(current_directory);
1632       return((char **) NULL);
1633     }
1634   /*
1635     Save the current and change to the new directory.
1636   */
1637   buffer=(struct dirent *) AcquireMagickMemory(sizeof(*buffer)+FILENAME_MAX+1);
1638   if (buffer == (struct dirent *) NULL)
1639     ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
1640   while ((MagickReadDirectory(current_directory,buffer,&entry) == 0) &&
1641          (entry != (struct dirent *) NULL))
1642   {
1643     if (*entry->d_name == '.')
1644       continue;
1645     if ((IsPathDirectory(entry->d_name) > 0) ||
1646 #if defined(MAGICKCORE_WINDOWS_SUPPORT)
1647         (GlobExpression(entry->d_name,pattern,MagickTrue) != MagickFalse))
1648 #else
1649         (GlobExpression(entry->d_name,pattern,MagickFalse) != MagickFalse))
1650 #endif
1651       {
1652         if (*number_entries >= max_entries)
1653           {
1654             /*
1655               Extend the file list.
1656             */
1657             max_entries<<=1;
1658             filelist=(char **) ResizeQuantumMemory(filelist,(size_t)
1659               max_entries,sizeof(*filelist));
1660             if (filelist == (char **) NULL)
1661               break;
1662           }
1663 #if defined(vms)
1664         {
1665           register char
1666             *p;
1667 
1668           p=strchr(entry->d_name,';');
1669           if (p)
1670             *p='\0';
1671           if (*number_entries > 0)
1672             if (LocaleCompare(entry->d_name,filelist[*number_entries-1]) == 0)
1673               continue;
1674         }
1675 #endif
1676         filelist[*number_entries]=(char *) AcquireString(entry->d_name);
1677         (*number_entries)++;
1678       }
1679   }
1680   buffer=(struct dirent *) RelinquishMagickMemory(buffer);
1681   (void) closedir(current_directory);
1682   if (filelist == (char **) NULL)
1683     return((char **) NULL);
1684   /*
1685     Sort filelist in ascending order.
1686   */
1687   qsort((void *) filelist,(size_t) *number_entries,sizeof(*filelist),
1688     FileCompare);
1689   return(filelist);
1690 }
1691 
1692 /*
1693 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1694 %                                                                             %
1695 %                                                                             %
1696 %                                                                             %
1697 %   M a g i c k D e l a y                                                     %
1698 %                                                                             %
1699 %                                                                             %
1700 %                                                                             %
1701 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1702 %
1703 %  MagickDelay() suspends program execution for the number of milliseconds
1704 %  specified.
1705 %
1706 %  The format of the Delay method is:
1707 %
1708 %      void MagickDelay(const MagickSizeType milliseconds)
1709 %
1710 %  A description of each parameter follows:
1711 %
1712 %    o milliseconds: Specifies the number of milliseconds to delay before
1713 %      returning.
1714 %
1715 */
MagickDelay(const MagickSizeType milliseconds)1716 MagickExport void MagickDelay(const MagickSizeType milliseconds)
1717 {
1718   if (milliseconds == 0)
1719     return;
1720 #if defined(MAGICKCORE_HAVE_NANOSLEEP)
1721   {
1722     struct timespec
1723       timer;
1724 
1725     timer.tv_sec=(time_t) (milliseconds/1000);
1726     timer.tv_nsec=(milliseconds % 1000)*1000*1000;
1727     (void) nanosleep(&timer,(struct timespec *) NULL);
1728   }
1729 #elif defined(MAGICKCORE_HAVE_USLEEP)
1730   usleep(1000*milliseconds);
1731 #elif defined(MAGICKCORE_HAVE_SELECT)
1732   {
1733     struct timeval
1734       timer;
1735 
1736     timer.tv_sec=(long) milliseconds/1000;
1737     timer.tv_usec=(long) (milliseconds % 1000)*1000;
1738     (void) select(0,(XFD_SET *) NULL,(XFD_SET *) NULL,(XFD_SET *) NULL,&timer);
1739   }
1740 #elif defined(MAGICKCORE_HAVE_POLL)
1741   (void) poll((struct pollfd *) NULL,0,(int) milliseconds);
1742 #elif defined(MAGICKCORE_WINDOWS_SUPPORT)
1743   Sleep((long) milliseconds);
1744 #elif defined(vms)
1745   {
1746     float
1747       timer;
1748 
1749     timer=milliseconds/1000.0;
1750     lib$wait(&timer);
1751   }
1752 #elif defined(__BEOS__)
1753   snooze(1000*milliseconds);
1754 #else
1755   {
1756     clock_t
1757       time_end;
1758 
1759     time_end=clock()+milliseconds*CLOCKS_PER_SEC/1000;
1760     while (clock() < time_end)
1761     {
1762     }
1763   }
1764 #endif
1765 }
1766 
1767 /*
1768 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1769 %                                                                             %
1770 %                                                                             %
1771 %                                                                             %
1772 %  M u l t i l i n e C e n s u s                                              %
1773 %                                                                             %
1774 %                                                                             %
1775 %                                                                             %
1776 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1777 %
1778 %  MultilineCensus() returns the number of lines within a label.  A line is
1779 %  represented by a \n character.
1780 %
1781 %  The format of the MultilineCenus method is:
1782 %
1783 %      size_t MultilineCensus(const char *label)
1784 %
1785 %  A description of each parameter follows.
1786 %
1787 %   o  label:  This character string is the label.
1788 %
1789 */
MultilineCensus(const char * label)1790 MagickExport size_t MultilineCensus(const char *label)
1791 {
1792   size_t
1793     number_lines;
1794 
1795   /*
1796     Determine the number of lines within this label.
1797   */
1798   if (label == (char *) NULL)
1799     return(0);
1800   for (number_lines=1; *label != '\0'; label++)
1801     if (*label == '\n')
1802       number_lines++;
1803   return(number_lines);
1804 }
1805 
1806 /*
1807 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1808 %                                                                             %
1809 %                                                                             %
1810 %                                                                             %
1811 %   S h r e d F i l e                                                         %
1812 %                                                                             %
1813 %                                                                             %
1814 %                                                                             %
1815 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1816 %
1817 %  ShredFile() overwrites the specified file with zeros or random data and then
1818 %  removes it.  The overwrite is optional and is only required to help keep
1819 %  the contents of the file private.  On the first pass, the file is zeroed.
1820 %  For subsequent passes, random data is written.
1821 %
1822 %  The format of the ShredFile method is:
1823 %
1824 %      MagickBooleanType ShredFile(const char *path)
1825 %
1826 %  A description of each parameter follows.
1827 %
1828 %    o path:  Specifies a path to a file.
1829 %
1830 */
ShredFile(const char * path)1831 MagickPrivate MagickBooleanType ShredFile(const char *path)
1832 {
1833   char
1834     *passes;
1835 
1836   int
1837     file,
1838     status;
1839 
1840   MagickSizeType
1841     length;
1842 
1843   register ssize_t
1844     i;
1845 
1846   size_t
1847     quantum;
1848 
1849   struct stat
1850     file_stats;
1851 
1852   if ((path == (const char *) NULL) || (*path == '\0'))
1853     return(MagickFalse);
1854   passes=GetPolicyValue("system:shred");
1855   if (passes == (char *) NULL)
1856     passes=GetEnvironmentValue("MAGICK_SHRED_PASSES");
1857   if (passes == (char *) NULL)
1858     {
1859       /*
1860         Don't shred the file, just remove it.
1861       */
1862       status=remove_utf8(path);
1863       if (status == -1)
1864         {
1865           (void) LogMagickEvent(ExceptionEvent,GetMagickModule(),
1866             "Failed to remove: %s",path);
1867           return(MagickFalse);
1868         }
1869       return(MagickTrue);
1870     }
1871   file=open_utf8(path,O_WRONLY | O_EXCL | O_BINARY,S_MODE);
1872   if (file == -1)
1873     {
1874       /*
1875         Don't shred the file, just remove it.
1876       */
1877       passes=DestroyString(passes);
1878       status=remove_utf8(path);
1879       if (status == -1)
1880         (void) LogMagickEvent(ExceptionEvent,GetMagickModule(),
1881           "Failed to remove: %s",path);
1882       return(MagickFalse);
1883     }
1884   /*
1885     Shred the file.
1886   */
1887   quantum=(size_t) MagickMaxBufferExtent;
1888   if ((fstat(file,&file_stats) == 0) && (file_stats.st_size > 0))
1889     quantum=(size_t) MagickMin(file_stats.st_size,MagickMaxBufferExtent);
1890   length=(MagickSizeType) file_stats.st_size;
1891   for (i=0; i < (ssize_t) StringToInteger(passes); i++)
1892   {
1893     RandomInfo
1894       *random_info;
1895 
1896     register MagickOffsetType
1897       j;
1898 
1899     ssize_t
1900       count;
1901 
1902     if (lseek(file,0,SEEK_SET) < 0)
1903       break;
1904     random_info=AcquireRandomInfo();
1905     for (j=0; j < (MagickOffsetType) length; j+=count)
1906     {
1907       StringInfo
1908         *key;
1909 
1910       key=GetRandomKey(random_info,quantum);
1911       if (i == 0)
1912         ResetStringInfo(key);  /* zero on first pass */
1913       count=write(file,GetStringInfoDatum(key),(size_t)
1914         MagickMin((MagickSizeType) quantum,length-j));
1915       key=DestroyStringInfo(key);
1916       if (count <= 0)
1917         {
1918           count=0;
1919           if (errno != EINTR)
1920             break;
1921         }
1922     }
1923     random_info=DestroyRandomInfo(random_info);
1924     if (j < (MagickOffsetType) length)
1925       break;
1926   }
1927   status=close(file);
1928   status=remove_utf8(path);
1929   if (status != -1)
1930     status=StringToInteger(passes);
1931   passes=DestroyString(passes);
1932   return((status == -1 || i < (ssize_t) status) ? MagickFalse : MagickTrue);
1933 }
1934