"{ Encoding: utf8 }"

"

 COPYRIGHT (c) 1997 by eXept Software AG

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libbasic' }"

"{ NameSpace: Smalltalk }"

Filename subclass:#PCFilename

	instanceVariableNames:''

	classVariableNames:'StandardSuffixTable NextTempFilenameIndex'

	poolDictionaries:''

	category:'OS-Windows'

!

!PCFilename class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1997 by eXept Software AG

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    Filenames in Windows-NT / Win95.

"

! !

!PCFilename class methodsFor:'initialization'!

initStandardSuffixTable

    "since there is no 'file' command to extract the type,

     return a guess based upon the files suffix. The following

     table defines what is returned."

    StandardSuffixTable := Dictionary new.

    #(

	'COM'   'executable'

	'DIR'   'directory'

	'EXE'   'executable'

	'LST'   'listing'

	'OBJ'   'object file'

	'TMP'   'temporary'

	'BAS'   'basic source'

	'C'     'c source'

	'COB'   'cobol source'

	'FOR'   'fortran source'

	'PAS'   'pascal source'

	'PL1'   'PL/1 source'

	'ST'    'smalltalk source'

	'STH'   'stc generated header'

	'DLL'   'dynamic link library'

    ) pairWiseDo:[:k :v |

	StandardSuffixTable at:k put:v

    ]

    "

     StandardSuffixTable := nil.

     self initStandardSuffixTable

    "

    "Modified: 16.10.1997 / 13:12:39 / cg"

! !

!PCFilename class methodsFor:'instance creation'!

named:aString

    "return a filename for a directory named aString.

     This is the same as 'aString asFilename'."

    |fn|

    fn := super named:aString.

    fn makeNonDOSName.

    ^fn

!

newTemporaryIn:aDirectoryPrefix

    "return a new unique filename - use this for temporary files.

     redefined to always return an MSDOS 8+3 fileName,

     in case the tempFile is passed to an OLD dos utility.."

    |pid nr nameString|

    NextTempFilenameIndex isNil ifTrue:[

	NextTempFilenameIndex := 1.

    ].

    pid := OperatingSystem getProcessId printString.

    pid := pid copyLast:(3 min:pid size).

    nr := NextTempFilenameIndex printString.

    nr := nr copyLast:(3 min:nr size).

    nameString := (self tempFileNameTemplate) bindWith:pid with:nr.

    NextTempFilenameIndex := NextTempFilenameIndex + 1.

    (aDirectoryPrefix isNil or:[aDirectoryPrefix asString isEmpty]) ifFalse:[

	^ aDirectoryPrefix asFilename construct:nameString

    ].

    ^ self named:nameString

    "temp files in '/tmp':

     Filename newTemporary

    "

    "temp files somewhere

     (not recommended - use above since it can be controlled via shell variables):

     Filename newTemporaryIn:'/tmp'

     Filename newTemporaryIn:'/tmp'

     Filename newTemporaryIn:'/usr/tmp'

     Filename newTemporaryIn:'/'

    "

    "a local temp file:

     Filename newTemporaryIn:''

     Filename newTemporaryIn:nil

     Filename newTemporaryIn:'.'

     Filename newTemporaryIn:('source' asFilename)

    "

    "Modified: / 07-09-1995 / 10:48:31 / claus"

    "Created: / 30-01-1998 / 11:49:33 / md"

    "Modified: / 30-01-1998 / 12:09:18 / dq"

    "Modified: / 23-03-2011 / 16:29:34 / cg"

!

rootComponents:aCollectionOfDirectoryNames

    |rootDirOrVolume|

    aCollectionOfDirectoryNames notEmpty ifTrue:[

        rootDirOrVolume := aCollectionOfDirectoryNames first.

        (rootDirOrVolume endsWith:$:) ifTrue:[

            "do not add a leading \ to C:"    

            ^ self fromComponents:aCollectionOfDirectoryNames.

         ].

    ].

    ^ super rootComponents:aCollectionOfDirectoryNames.

!

rootDirectoryOnVolume:aVolumeName

    "return a filename for the root directory on some volume"

    ^ self named:(aVolumeName , '\')

    "

     Filename rootDirectoryOnVolume:'d:'

     Filename rootDirectoryOnVolume:'\\idefix\home'

    "

    "Modified: / 24.9.1998 / 19:06:15 / cg"

! !

!PCFilename class methodsFor:'defaults'!

defaultTempDirectoryName

    "return the default temp directory as a filename.

     This is used, if no special preferences were defined in

     any of the TEMP-environment variables (see tempDirectory)."

    |winDir vol tempDirString tempDir|

    "/ if no explicit temp dir environment variable has been specified,

    "/ use the ALLUSERS common folder and create an stx_tmp folder there.

    "/ this will only happen for services which are installed to run under system

    "/ instead of under any particular user.

    #('STX_TMPDIR' 'ST_TMPDIR' 'TMPDIR' 'TEMPDIR' 'TEMP' 'TMP' 'ALLUSERSPROFILE') do:[:envVar |

	tempDirString := OperatingSystem getEnvironment:envVar.

	tempDirString notNil ifTrue:[

	    "/ kludge when running cygwin: replace '/cygdrive/X/...'

	    "/ by X:\...

	    (tempDirString startsWith:'/cygdrive/') ifTrue:[

		tempDirString := tempDirString withoutPrefix:'/cygdrive/'.

		tempDirString size > 2 ifTrue:[

		    (tempDirString at:2) == $/ ifTrue:[

			tempDirString := (tempDirString at:1) asString , ':' ,

				   ((tempDirString copyFrom:2) replaceAll:$/ with:$\).

		    ].

		].

	    ].

	    tempDir := self named:tempDirString.

	    (tempDir exists and:[ tempDir isWritable ]) ifTrue:[

		('Filename [info]: using tmp folder "%1" as specified by environment: "%2"'

		    bindWith:tempDir pathName with:envVar) infoPrintCR.

		^ tempDir asFilename.

	    ].

	].

    ].

    winDir := OperatingSystem getWindowsDirectory asFilename.

    vol := winDir volume.

    tempDir := vol asFilename construct:'temp'.

    (tempDir exists and:[ tempDir isWritable ]) ifFalse:[

	tempDir := vol asFilename construct:'tmp'.

	(tempDir exists and:[ tempDir isWritable ]) ifFalse:[

	    tempDir := winDir construct:'temp'.

	    (tempDir exists and:[ tempDir isWritable ]) ifFalse:[

		tempDir := '.\temp' asFilename

	    ]

	]

    ].

    ('Filename [info]: using fallback windows tmp folder: ',tempDir pathName) infoPrintCR.

    ^ tempDir

    "

     Filename defaultTempDirectoryName

     Filename defaultTempDirectoryName exists

     Filename defaultTempDirectoryName isWritable

    "

!

defaultVolumeName

    "return the default volume name."

    ^ 'c:'

! !

!PCFilename class methodsFor:'misc'!

nameWithSpecialExpansions:aString

    "return the nameString, expanding any OS specific macros.

     Here, a ~/ or ~user/ prefix is expanded to the users home dir (as in csh)"

    |expandedString|

    expandedString := aString.

    (expandedString includes:$%) ifTrue:[

        expandedString := OperatingSystem expandEnvironmentStrings:expandedString.

    ].

    (expandedString startsWith:$~) ifTrue:[

        ^ super nameWithSpecialExpansions:expandedString.

    ].

    ^ expandedString

    "

        self nameWithSpecialExpansions:'c:/windows'

        self nameWithSpecialExpansions:'%ProgramFiles%\exept\expecco'

        self nameWithSpecialExpansions:'~\exept\expecco'

        self nameWithSpecialExpansions:'~stefan\exept\expecco'

    "

! !

!PCFilename class methodsFor:'queries'!

isBadCharacter:aCharacter

    "return true, if aCharacter is unallowed in a filename."

    ^ ('<>:"/\|?*' includes:aCharacter) or:[super isBadCharacter:aCharacter]

!

isCaseSensitive

    "return true, if filenames are case sensitive."

    ^ false

!

nullFilename

    "Return the OS dependent filename for the data sink, or nil if there is none"

    ^ 'nul:'

!

parentDirectoryName

    "return the name used for the parent directory.

     This is '..' for unix and dos-like systems.

     (there may be more in the future."

    ^ '..'

!

separator

    "return the file/directory separator."

     ^ $\

     "

      Filename concreteClass separator

     "

    "Modified: 8.9.1997 / 00:18:03 / cg"

!

tempFileNameTemplate

    "return a template for temporary files.

     This is expanded with the current processID and a sequenceNumber

     to generate a unique filename.

     Redefined for MSDOS 8+3 filenames"

    ^ 'st%1%2'

    "Created: 30.1.1998 / 12:09:18 / dq"

! !

!PCFilename methodsFor:'attribute setter'!

setHidden

    "return true, if the hidden attribute could be setted to true"

    ^ OperatingSystem setHidden:(self osNameForFile)

!

setNormal

    "

    sets all file attributes to the normal state

    e.g. set the hidden attribute to false (unhidden)

    "

    ^ OperatingSystem setNormal:(self osNameForFile)

! !

!PCFilename methodsFor:'converting'!

makeDOSName

    "convert the receivers name to be a DOS filename."

    nameString := self fullAlternativePathName.

    "

     'C:\Dokumente und Einstellungen\str\Desktop\output folder\' asFilename makeDOSName

    "

!

makeLegalFilename

    "convert the receivers name to be a legal filename.

     This removes/replaces invalid characters and/or compresses

     the name as required by Win95-WinNT."

    |srchStart separator|

    "/ there may be only one colon in the name

    "/ (and if present, it must be the second character)

    ((nameString size >= 2)

    and:[(nameString at:2) == $:]) ifTrue:[

        srchStart := 3.

    ] ifFalse:[

        srchStart := 1

    ].

    "/ replace colons by underscore

    "/ may need more to convert - time will show

    separator := self separator.

    nameString := nameString copy 

                    replaceAllForWhich:[:each| each ~= separator 

                                               and:[self class isBadCharacter:each]] 

                    with:$_ from:srchStart to:(nameString size).

    "

     'hello world' asFilename makeLegalFilename

     'hello<>world' asFilename makeLegalFilename

     'hello:world' asFilename makeLegalFilename

     'hello::world' asFilename makeLegalFilename

     'c:hello::world' asFilename makeLegalFilename

     '\\idefix' asFilename makeLegalFilename

     '\\idefix\' asFilename makeLegalFilename

    "

    "Modified: / 01-12-2010 / 18:53:59 / cg"

!

makeNonDOSName

    "convert the receivers name to be a full filename, in case its an abbreviated (alternative) DOS name.

     This removes/replaces components of the form FOOBAR~n by the real, full components name."

    |directory directoryName baseName info|

    (nameString includes:$~) ifFalse:[^self].

    (nameString startsWith:$~) ifTrue:[^self].

    directoryName := self directoryName.

    directoryName = nameString ifTrue:[^self].

    baseName := self baseName.

    (baseName includes:$~) ifTrue:[

	info := self info.

	info notNil ifTrue:[

	    baseName := info fullName.

	].

	directory := self class named:directoryName.

	directory isRootDirectory ifFalse:[

	    directory makeNonDOSName.

	].

	nameString := directory constructString:baseName

    ].

    "

     Filename tempDirectory makeNonDOSName

    "

    "Modified: / 11.10.1998 / 01:40:47 / cg"

! !

!PCFilename methodsFor:'file operations'!

renameTo:newName

    "rename the file - the argument must be convertable to a String.

     Raise an error if not successful.

     Redefined to delete any existing target-file first.

     Also take care of possible locks by antivirus scanners, that go away after some time."

    |retryCtr newFilename|

    "try 5 times (retry 4 times) if file has just been written to and is locked by a virus scanner"

    retryCtr := 4.

    [

        ^ super renameTo:newName

    ] on:OSErrorHolder existingReferentSignal do:[:ex|

        |newFilename|

        newFilename := newName asFilename.

        (self pathName sameAs:newFilename pathName) ifTrue:[

            ex reject.

        ].

        newFilename remove.

        ex restart.

    ] on:OSErrorHolder noPermissionsSignal do:[:ex|

        retryCtr > 0 ifTrue:[

            Logger warning:'Error caught while renaming %1 to %2 - maybe temporary locked by virus scanner, still trying: %3'

                                with:self pathName

                                with:newFilename pathName

                                with:ex description.

            retryCtr := retryCtr - 1.

            Delay waitForMilliseconds:200.

            ex restart.

        ] ifFalse:[

            ex reject

        ].

    ].

    "

     'c:\users\stefan\test.txt' asFilename  renameTo:'c:\users\stefan\test1.txt'

     'c:\users\stefan\test12.txt' asFilename  renameTo:'c:\users\stefan\test.txt'

    "

    "Modified: / 20-01-1998 / 15:33:00 / md"

    "Modified: / 21-09-2006 / 18:19:47 / cg"

! !

!PCFilename methodsFor:'queries'!

directoryName

    "return the directory name part of the file/directory as a string.

     - thats the name of the directory where the file/dir represented by

       the receiver is contained in.

     This method does not check if the path is valid.

     (i.e. '/usr/lib/st/file' asFilename directoryName -> '/usr/lib/st'

       and '/usr/lib' asFilename directoryName         -> /usr').

     (this is almost equivalent to #directory, but returns

      a string instead of a Filename instance).

     See also: #pathName, #directoryPathName and #baseName.

     Compatibility note: use #head for ST-80 compatibility."

    |nm|

    (nameString endsWith:':\') ifTrue:[

	^ nameString

    ].