annotate mayachemtools/lib/FileUtil.pm @ 2:dfff2614510e draft

Deleted selected files
author deepakjadmin
date Wed, 20 Jan 2016 12:15:15 -0500
parents 73ae111cf86f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 package FileUtil;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 # $RCSfile: FileUtil.pm,v $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 # $Date: 2015/02/28 20:47:17 $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 # $Revision: 1.40 $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 # Author: Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 # Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 # This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 # MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 # the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 # Software Foundation; either version 3 of the License, or (at your option) any
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 # later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 # MayaChemTools is distributed in the hope that it will be useful, but without
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 # any warranty; without even the implied warranty of merchantability of fitness
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 # for a particular purpose. See the GNU Lesser General Public License for more
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 # details.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 # You should have received a copy of the GNU Lesser General Public License
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 # along with MayaChemTools; if not, see <http://www.gnu.org/licenses/> or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 # write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 # Boston, MA, 02111-1307, USA.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 use strict;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 use Exporter;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 use Carp;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 use File::stat;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 use Time::localtime ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 use TextUtil ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 @ISA = qw(Exporter);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 @EXPORT = qw(CheckFileType ConvertCygwinPath ExpandFileNames FileModificationTimeAndDate FormattedFileModificationTimeAndDate FileSize FormatFileSize GetMayaChemToolsLibDirName GetUsageFromPod ParseFileName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 @EXPORT_OK = qw();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 %EXPORT_TAGS = (all => [@EXPORT, @EXPORT_OK]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 # Setup package variables...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 my($MayaChemToolsLibDir);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 # Check to see path contains cygdrive and convert it into windows path...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 sub ConvertCygwinPath {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 my($Path) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 my($NewPath, $OSName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 $NewPath = $Path; $OSName = $^O;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 if ($OSName =~ /cygwin/i && $Path =~ /cygdrive/i ) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 my(@PathParts) = split "\/", $Path;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 my($Drive) = $PathParts[2];
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 shift @PathParts; shift @PathParts; shift @PathParts;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 $NewPath = join "\/", @PathParts;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 $NewPath = $Drive. ":\/" . $NewPath;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 return $NewPath;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 # Based on the file name extension, figure out its type.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 sub CheckFileType {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 my($FileName, $FileExts) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 my($Status, @FileExtsList, $Index, $Ext);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 $Status = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 @FileExtsList = split " ", $FileExts;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 for $Index (0 .. $#FileExtsList) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 $Ext = $FileExtsList[$Index];
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 if ($FileName =~ /(\.$Ext)$/i) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 $Status = 1;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 return ($Status);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 # Expand file names using specified directory and/or file names along with any
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 # file extensions containing one or more wild cards. And return the expanded
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 # list.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 # IncludeDirName controls whether directory prefixes are included in expanded
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 # file names. Default is to always append directory name before expanded file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 # name.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 # Notes:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 # . Multiple file extensions are delimited by spaces.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 # . Wild card, *, is supported in directory and file names along with file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 # extensions.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 # . For a specified directory name in the files list, all the files in the
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 # directory are retrieved using Perl opendir function and files filtered using file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 # extensions. The file names "." and ".." returned by opendir are ignored.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 # . For file names containing wild cards with and without any explicit file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 # extension specification in the file name, all the files in the directory are retrieved
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 # using Perl opendir function and files filtered using file name along with any
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 # file extension. The file names "." and ".." returned by opendir are ignored.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 sub ExpandFileNames {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 my($Files, $FileExts, $IncludeDirName) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 my($FileName, $Index, $Delimiter, $FileExtsPattern, @FilesList, @DirFileNames);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 # Check whether to include directory name in expanded file names...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 $IncludeDirName = defined $IncludeDirName ? $IncludeDirName : 1;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 # Setup file externsions...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 $FileExtsPattern = "";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 if ($FileExts) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 $FileExtsPattern = join "|", split " ", $FileExts;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 if ($FileExtsPattern =~ /\*/) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 # Replace * by .*? for greedy match...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 $FileExtsPattern =~ s/\*/\.\*\?/g;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 @FilesList = ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 FILEINDEX: for ($Index = 0; $Index < @$Files; $Index++) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 $FileName = @$Files[$Index];
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 $Delimiter = "\/";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 if ($FileName =~ /\\/ ) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 $Delimiter = "\\";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 if (-d $FileName) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 my($DirName, $DirNamePrefix);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 $DirName = $FileName;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 $DirNamePrefix = $IncludeDirName ? "$DirName$Delimiter" : "";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 # glob doesn't appear to work during command line invocation from Windows.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 # So, use opendir to make it work...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 # push @FilesList, map {glob("$DirName/*.$_")} split " ", $FileExts;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 @DirFileNames = ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 if (!opendir DIRNAME, $DirName) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 carp "Warning: Ignoring directory $DirName: Couldn't open it: $! ...";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 next FILEINDEX;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 # Collect file names without '.' and '..' as readdir function places them on the list...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 @DirFileNames = map { "$DirNamePrefix$_" } grep { !/^(\.|\.\.)$/ } readdir DIRNAME;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 closedir DIRNAME;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 # Collect files with any specified file extensions...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 if ($FileExtsPattern) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 @DirFileNames = grep { /\.$FileExtsPattern$/ } @DirFileNames;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 push @FilesList, @DirFileNames;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 elsif ($FileName =~ /\*/) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154 my($FileDir, $Name, $FileExt, $DirNamePrefix);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
155
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
156 # Filenames are not expanded during command line invocation from Windows...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
157 ($FileDir, $Name, $FileExt) = ParseFileName($FileName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
158
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
159 $DirNamePrefix = $IncludeDirName ? "$FileDir$Delimiter" : "";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
160
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
161 @DirFileNames = ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
162 if (!opendir FILEDIR, $FileDir) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
163 carp "Warning: Ignoring files $FileName: Couldn't open directory $FileDir: $! ...";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
164 next FILEINDEX;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
165 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
166
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
167 # Collect file names without '.' and '..' as readdir function places them on the list...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
168 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
169 @DirFileNames = map { "$DirNamePrefix$_" } grep { !/^(\.|\.\.)$/ } readdir FILEDIR;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
170 closedir FILEDIR;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
171
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
172 if (length($Name) > 1) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
173 # Replace * by .*? for greedy match...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
174 $Name =~ s/\*/\.\*\?/g;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
175 @DirFileNames = grep { /$Name/ } @DirFileNames;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
176 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
177
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
178 if ($FileExt) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
179 $FileExt =~ s/\*/\.\*\?/g;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
180 @DirFileNames = grep { /\.$FileExt$/ } @DirFileNames;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
181 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
182 elsif ($FileExtsPattern) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
183 @DirFileNames = grep { /\.$FileExtsPattern$/ } @DirFileNames;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
184 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
185
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
186 push @FilesList, @DirFileNames;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
187 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
188 else {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
189 push @FilesList, $FileName;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
190 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
191 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
192 return @FilesList;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
193 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
194
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
195 # Formatted file modification time...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
196 sub FormattedFileModificationTimeAndDate {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
197 my($FileName) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
198 my($TimeString, $DateString) = ('') x 2;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
199
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
200 if (! -e $FileName) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
201 return ($TimeString, $DateString);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
202 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
203 my($Hours, $Mins, $Secs, $DayName, $MonthName, $Month, $Year) = FileModificationTimeAndDate($FileName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
204
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
205 # Setup time suffix...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
206 my($TimeSuffix) = '';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
207 if ($Hours < 12) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
208 $TimeSuffix = 'AM';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
209 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
210 elsif ($Hours > 12) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
211 $TimeSuffix = 'PM';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
212 $Hours = $Hours - 12;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
213 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
214 elsif ($Hours == 12 && ($Mins > 0 || $Secs > 0)) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
215 $TimeSuffix = 'PM';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
216 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
217 elsif ($Hours == 12 && $Mins == 0 && $Secs == 0) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
218 $TimeSuffix = 'Noon';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
219 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
220
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
221 $Month = TextUtil::AddNumberSuffix($Month);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
222
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
223 $TimeString = "${DayName} ${Hours}:${Mins}:${Secs} ${TimeSuffix}";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
224 $DateString = "${MonthName} ${Month}, ${Year}";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
225
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
226 return ($TimeString, $DateString);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
227 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
228
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
229 # File modifcation time and date...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
230 sub FileModificationTimeAndDate {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
231 my($FileName) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
232 my($Hours, $Mins, $Secs, $DayName, $MonthName, $Month, $Year) = ('') x 7;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
233
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
234 if (! -e $FileName) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
235 return ($Hours, $Mins, $Secs, $DayName, $MonthName, $Month, $Year);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
236 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
237
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
238 my($CTimeString, $FileStatRef, $TimeStamp);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
239 $FileStatRef = stat($FileName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
240
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
241 $CTimeString = Time::localtime::ctime($FileStatRef->mtime);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
242
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
243 # ctime returns: Thu Aug 3 10:13:53 2006
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
244 ($DayName, $MonthName, $Month, $TimeStamp, $Year) = split /[ ]+/, $CTimeString;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
245 ($Hours, $Mins, $Secs) = split /\:/, $TimeStamp;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
246
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
247 return ($Hours, $Mins, $Secs, $DayName, $MonthName, $Month, $Year);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
248 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
249
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
250 # Format file size...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
251 sub FormatFileSize {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
252 my($Precision, $Size);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
253
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
254 $Precision = 1;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
255 if (@_ == 2) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
256 ($Size, $Precision) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
257 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
258 else {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
259 ($Size) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
260 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
261 my($SizeDenominator, $SizeSuffix);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
262 FORMAT: {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
263 if ($Size < 1024) { $SizeDenominator = 1; $SizeSuffix = 'bytes'; last FORMAT;}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
264 if ($Size < (1024*1024)) { $SizeDenominator = 1024; $SizeSuffix = 'KB'; last FORMAT;}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
265 if ($Size < (1024*1024*1024)) { $SizeDenominator = 1024*1024; $SizeSuffix = 'MB'; last FORMAT;}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
266 if ($Size < (1024*1024*1024*1024)) { $SizeDenominator = 1024*1024*1024; $SizeSuffix = 'GB'; last FORMAT;}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
267 $SizeDenominator = 1; $SizeSuffix = 'bytes';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
268 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
269 $Size /= $SizeDenominator;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
270 $Size = sprintf("%.${Precision}f", $Size) + 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
271 $Size = "$Size $SizeSuffix";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
272
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
273 return $Size;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
274 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
275
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
276 # Get file size in bytes...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
277 sub FileSize {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
278 my($File) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
279
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
280 if (! -e $File) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
281 return undef;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
282 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
283 return (-s $File)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
284 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
285
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
286 # Get MayaChemTool's lib directory name using @INC to extract
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
287 # <MAYACHEMTOOLS>/lib directory location: first entry in @INC path should contain
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
288 # MayaChemTools modules location
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
289 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
290 sub GetMayaChemToolsLibDirName {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
291
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
292 if (defined $MayaChemToolsLibDir) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
293 return $MayaChemToolsLibDir;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
294 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
295
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
296 $MayaChemToolsLibDir = "";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
297 if ($INC[0] =~ /MayaChemTools/i) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
298 $MayaChemToolsLibDir = $INC[0];
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
299 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
300 else {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
301 # Go through rest of the entries...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
302 my($Index);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
303 INDEX: for $Index (1 .. $#INC) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
304 if ($INC[$Index] =~ /MayaChemTools/i) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
305 $MayaChemToolsLibDir = $INC[$Index];
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
306 last INDEX;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
307 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
308 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
309 if (!$MayaChemToolsLibDir) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
310 carp "Warning: MayaChemTools lib directory location doesn't appear to exist in library search path specified by \@INC ...";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
311 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
312 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
313 return $MayaChemToolsLibDir;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
314 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
315
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
316 # Get Usage from Pod...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
317 sub GetUsageFromPod {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
318 my($Usage, $ScriptPath);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
319
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
320 ($ScriptPath) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
321 $Usage = "Script usage not available: pod2text or pod2text.bat doesn't exist in your Perl installation and direct invocation of Pod::Text also failed\n";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
322
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
323 # Get pod documentation: try pod2text first followed by perdoc.bat in case it fails to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
324 # to handle ActiveState Perl...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
325 my($PodStatus);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
326 $PodStatus = (open CMD, "pod2text $ScriptPath|") ? 1 : ((open CMD, "pod2text.bat $ScriptPath|") ? 1 : 0);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
327 if (!$PodStatus) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
328 # Try direct invocation of Pod::Text before giving up...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
329 my($PodTextCmd);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
330 $PodTextCmd = "perl -e \'use Pod::Text (); \$TextFormatter = Pod::Text->new(); \$TextFormatter->parse_from_file(\"$ScriptPath\");\'";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
331 $PodStatus = (open CMD, "$PodTextCmd|") ? 1 : 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
332 if (!$PodStatus) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
333 return $Usage;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
334 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
335 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
336 my($ProcessingSection, $InParametersSection, $InOptionsSection, @LineWords);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
337 $ProcessingSection = 0; $InParametersSection = 0; $InOptionsSection = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
338 PODLINE: while (<CMD>) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
339 if (/^SYNOPSIS/) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
340 $_ = <CMD>; chomp; s/^ +//g;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
341 (@LineWords) = split / /;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
342 $Usage = qq(Usage: $LineWords[0] [-options]... );
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
343 shift @LineWords;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
344 $Usage .= join(" ", @LineWords) . "\n";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
345 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
346 elsif (/^(DESCRIPTION|PARAMETERS|OPTIONS|EXAMPLES|AUTHOR|SEE ALSO|COPYRIGHT)/i) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
347 # Various sections...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
348 chomp;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
349 $Usage .= ucfirst(lc($_)) . ":\n";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
350 $ProcessingSection = 1;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
351 $InOptionsSection = /^OPTIONS/ ? 1 : 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
352 $InParametersSection = /^PARAMETERS/ ? 1 : 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
353 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
354 elsif ($InParametersSection|$InOptionsSection) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
355 if (/^[ ]+\-/ || /^[ ]{4,4}/) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
356 # Start of option line: any number of spaces followed by - sign.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
357 # Put back in <> which pod2text replaced to **
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
358 my($OptionLine) = qq($_);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
359 OPTIONLINE: while (<CMD>) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
360 if (/^( )/) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
361 $OptionLine .= qq($_);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
362 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
363 else {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
364 $OptionLine =~ s/\*(([a-zA-Z0-9])|(\[)|(\#)|(\"))/"\<" . substr($&, -1, 1)/e;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
365 $OptionLine =~ s/(([a-zA-Z0-9])|(\])|(\#)|(\"))\*/substr($&, 0, 1) . "\>"/e;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
366 $Usage .= qq($OptionLine$_);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
367 last OPTIONLINE;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
368 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
369 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
370 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
371 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
372 else {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
373 if ($ProcessingSection) { $Usage .= qq($_); }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
374 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
375 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
376 close CMD;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
377
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
378 # Take out **which pod2text puts in for <>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
379 $Usage =~ s/\*(([a-zA-Z0-9;#-])|(\")|(\()|(\[)|(\.))/substr($&, -1, 1)/eg;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
380 $Usage =~ s/(([a-zA-Z0-9;#-])|(\")|(\))|(\])|(\.))\*/substr($&, 0, 1)/eg;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
381
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
382 return $Usage;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
383 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
384
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
385 # Split full file name into directory path, file name, and the extension.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
386 sub ParseFileName {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
387 my($FullName) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
388 my($FileDir, $FileName, $FileExt, @FullFileNameParts, @FileNameParts, $Delimiter);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
389
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
390 $Delimiter = "\/";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
391 if ($FullName =~ /\\/ ) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
392 $Delimiter = "\\";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
393 $FullName =~ s/\\/\//g;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
394 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
395 $FileDir = ""; $FileName = ""; $FileExt = "";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
396 @FullFileNameParts = (); @FileNameParts = ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
397
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
398 @FullFileNameParts = split "\/", $FullName;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
399 @FileNameParts = split /\./, $FullFileNameParts[$#FullFileNameParts];
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
400
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
401 # Setup file dir...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
402 if (@FullFileNameParts == 1) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
403 $FileDir = "\.";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
404 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
405 else {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
406 pop @FullFileNameParts;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
407 $FileDir = join $Delimiter, @FullFileNameParts;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
408 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
409
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
410 # Setup file name and ext...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
411 if (@FileNameParts == 1) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
412 $FileName = $FileNameParts[0];
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
413 $FileExt = "";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
414 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
415 elsif (@FileNameParts == 2) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
416 $FileName = $FileNameParts[0];
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
417 $FileExt = $FileNameParts[1];
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
418 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
419 elsif (@FileNameParts > 2) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
420 # Use the last entry as file extension and the rest for file name...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
421 $FileExt = $FileNameParts[$#FileNameParts];
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
422 pop @FileNameParts;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
423 $FileName = join '.', @FileNameParts;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
424 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
425 return ($FileDir, $FileName, $FileExt);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
426 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
427
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
428 1;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
429
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
430 __END__
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
431
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
432 =head1 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
433
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
434 FileUtil
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
435
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
436 =head1 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
437
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
438 use FileUtil;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
439
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
440 use FileUtil qw(:all);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
441
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
442 =head1 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
443
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
444 B<FileUtil> module provides the following functions:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
445
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
446 CheckFileType, ConvertCygwinPath, ExpandFileNames, FileModificationTimeAndDate,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
447 FileSize, FormatFileSize, FormattedFileModificationTimeAndDate,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
448 GetMayaChemToolsLibDirName, GetUsageFromPod, ParseFileName
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
449
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
450 =head1 FUNCTIONS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
451
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
452 =over 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
453
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
454 =item B<CheckFileType>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
455
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
456 $Status = CheckFileType($FileName, $FileExts);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
457
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
458 Based on I<FileExts>, decides type of I<FileName> and return 1 or 0.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
459
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
460 =item B<ConvertCygwinPath>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
461
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
462 $NewPath = ConvertCygwinPath($Path);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
463
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
464 Check to see whether I<Path> contains any Cygwin drive specification and convert
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
465 it into Windows path.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
466
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
467 =item B<ExpandFileNames>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
468
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
469 @FilesList = ExpandFileNames(\@Files, $FileExts);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
470 @FilesList = ExpandFileNames(\@Files, $FileExts, $IncludeDirName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
471
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
472 For each directory name or wild card file name in I<Files>, generate all file names which
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
473 correspond to the specification along with match to any extensions in I<FileExts> and return an
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
474 array B<FileList> containing these file names and other names. I<IncludeDirName> controls
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
475 controls whether directory prefixes are included in expanded file names. Default is to always
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
476 append directory name before expanded file name.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
477
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
478 Notes:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
479
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
480 . Multiple file extensions are delimited by spaces.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
481 . Wild card, *, is supported in directory and file names along with file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
482 extensions.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
483 . For a specified directory name in the files list, all the files in the
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
484 directory are retrieved using Perl opendir function and files filtered using file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
485 extensions. The file names "." and ".." returned by opendir are ignored.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
486 . For file names containing wild cards with and without any explicit file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
487 extension specification in the file name, all the files in the directory are retrieved
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
488 using Perl opendir function and files filtered using file name along with any
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
489 file extension. The file names "." and ".." returned by opendir are ignored.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
490
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
491 =item B<FormattedFileModificationTimeAndDate>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
492
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
493 ($TimeString, $DateString) =
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
494 FormattedFileModificationTimeAndDate($FileName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
495
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
496 Returns a formatted time and date string corresponding to I<FileName> modification time.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
497
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
498 =item B<FileModificationTimeAndDate>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
499
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
500 ($Hours, $Mins, $Secs, $DayName, $MonthName, $Month, $Year) =
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
501 FileModificationTimeAndDate($FileName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
502
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
503 Returns file modification time and date values for specified I<FileName>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
504
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
505 =item B<FormatFileSize>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
506
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
507 $FormattedSize= FormatFileSize($Size, [$Precision]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
508
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
509 Formats the file size in bytes to human readable value and returns a formatted file
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
510 size string.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
511
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
512 =item B<FileSize>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
513
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
514 $Size= FileSize($FileName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
515
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
516 Returns size of I<FileName> in bytes
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
517
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
518 =item B<GetMayaChemToolsLibDirName>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
519
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
520 $MayaChemToolsLibDir = GetMayaChemToolsLibDirName();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
521
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
522 Returns MayaChemTools lib directory name by parsing B<INC> values to extract
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
523 B<MAYACHEMTOOLS/lib> directory location: first entry in B<INC> path should contain
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
524 MayaChemTools lib location.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
525
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
526 =item B<GetUsageFromPod>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
527
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
528 $ScriptUsage = GetUsageFromPod($AbsoluteScriptPath);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
529
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
530 Generates a B<ScriptUsage> string from pod documentation in the script file using
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
531 pod2text or perdoc.bat Perl utitities.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
532
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
533 =item B<ParseFileName>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
534
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
535 ($FileDir, $FileName, $FileExt) = ParseFileName($FullFileName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
536
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
537 Splits I<FullFileName> into directory name, file name, and extension. B<FileDir> is
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
538 set to current directory for absent directory name in I<FullFileName>. And I<FileExt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
539 is set to NULL string for I<FullFileName> without any extension.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
540
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
541 This function doesn't perform checking ragarding the presence of the directory I<FileDir>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
542 and I<FullFileName> and the I<FullFileName> without any extension is assumed to be
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
543 a file instead of a directory.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
544
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
545 =back
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
546
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
547 =head1 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
548
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
549 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
550
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
551 =head1 SEE ALSO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
552
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
553 TextUtil.pm, TimeUtil.pm
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
554
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
555 =head1 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
556
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
557 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
558
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
559 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
560
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
561 MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
562 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
563 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
564 any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
565
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
566 =cut