"

 COPYRIGHT (c) 2003 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:libtool' }"

"{ NameSpace: Smalltalk }"

Object subclass:#FileOperation

	instanceVariableNames:'errorString result actionForAll browser'

	classVariableNames:''

	poolDictionaries:''

	category:'Interface-Support'

!

FileOperation subclass:#Copy

	instanceVariableNames:'copiedFiles newFiles'

	classVariableNames:''

	poolDictionaries:''

	privateIn:FileOperation

!

FileOperation::Copy subclass:#CopyCorrupted

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:FileOperation

!

FileOperation subclass:#Create

	instanceVariableNames:'createdFile'

	classVariableNames:'LastCreatedDirectory LastCreatedFile'

	poolDictionaries:''

	privateIn:FileOperation

!

FileOperation subclass:#Delete

	instanceVariableNames:'fileName'

	classVariableNames:''

	poolDictionaries:''

	privateIn:FileOperation

!

FileOperation::Delete subclass:#Erase

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:FileOperation

!

FileOperation subclass:#Move

	instanceVariableNames:'movedFiles'

	classVariableNames:''

	poolDictionaries:''

	privateIn:FileOperation

!

FileOperation subclass:#Rename

	instanceVariableNames:'renamedFiles'

	classVariableNames:''

	poolDictionaries:''

	privateIn:FileOperation

!

!FileOperation class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 2003 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

"

    file operations which may run in the background

    CopyCorrupt:

        tries to skip over bad sectors in the input file, by skipping them and

        writing them as zeros. Used for partial recovering of old disks and tapes.

    Erase:

        fill file with zeros (to be really erased from the disk) before removing.

        We use this, if the file contains security relevant data (such as crypto-keys)

    [instance variables:]

        actionForAll .......... a 3-state (true/false/nil) flag, which controls if the current

                                action should be performed for all remaining files

                                (i.e. if deleting, and 'Same for all' was checked, and deletion was confirmed,

                                 the remaining files are also deleted without asking again).

                                If nil, the operation will ask again for the next file.

        result ................ boolean outcome                            

      In Create:        

        createdFile ........... name of created file/directory (name as given by user)                            

    [class variables:]

    [see also:]

"

! !

!FileOperation class methodsFor:'instance creation'!

copyCorruptedFile:aSourceFile to:aDestFile

    ^ CopyCorrupted new

        copyFile:aSourceFile to:aDestFile withOverWriteWarning:false copyFileIfSame:false

    "Created: / 07-02-2007 / 18:41:24 / cg"

!

copyFile:aSourceFile to:aDestFile withOverWriteWarning:overWriteWarningBoolean copyFileIfSame:copyIfSameBoolean

    ^ Copy

	copyFile:aSourceFile to:aDestFile

	withOverWriteWarning:overWriteWarningBoolean

	copyFileIfSame:copyIfSameBoolean

!

copyFiles:aColOfSourceFiles to:aDirectory

    ^ Copy copyFiles:aColOfSourceFiles to:aDirectory

!

createDirectoryIn:aDirectory

    ^ Create createDirectoryIn:aDirectory

!

createDirectoryIn:aDirectory initialAnswer:defaultAnswer

    ^ Create createDirectoryIn:aDirectory initialAnswer:defaultAnswer

!

createFileIn:aDirectory

    ^ Create createFileIn:aDirectory

!

createHardLinkIn:dir

    ^ Create createHardLinkIn:dir

!

createLinkIn:dir soft:soft

    ^ Create createLinkIn:dir soft:soft

!

createSoftLinkIn:dir

    ^ Create createSoftLinkIn:dir

!

deleteFiles:colOfFiles confirm:confirm

    ^ Delete deleteFiles:colOfFiles confirm:confirm

!

eraseFiles:colOfFiles confirm:confirm

    ^ Erase deleteFiles:colOfFiles confirm:confirm

!

moveFile:aSourceFile to:aDestFile

    ^ Move moveFile:aSourceFile to:aDestFile

!

moveFiles:aCollectionOfFiles to:aDestDirectory

    ^ Move moveFiles:aCollectionOfFiles to:aDestDirectory

!

new

    ^ self basicNew initialize

    "Created: / 30-11-2017 / 14:18:59 / cg"

!

renameFile:filename to:newFileString

    ^ Rename renameFile:filename to:newFileString

!

renameFiles:aCollectionofFilenames

    ^ Rename renameFiles:aCollectionofFilenames

! !

!FileOperation class methodsFor:'defaults'!

suffixForCopyOverExistingFile

    ^ '.copy'

! !

!FileOperation class methodsFor:'queries'!

isAbstract

    ^ self == FileOperation

! !

!FileOperation methodsFor:'accessing'!

errorString

    ^ errorString

!

errorString:something

    errorString := something.

!

result

    ^ result

!

result:aBoolean

    result := aBoolean.

    "Modified (format): / 30-11-2017 / 14:18:02 / cg"

! !

!FileOperation methodsFor:'dialogs & helpers'!

checkDirectoryExists:aDirectory

    aDirectory exists ifFalse:[

        (Dialog confirm:(AbstractFileBrowser classResources 

                            stringWithCRs:'Non-existing directory: %1\\Create?' 

                            with:aDirectory asString)

        ) ifFalse:[

            ^ false

        ].

        aDirectory recursiveMakeDirectory.

        aDirectory exists ifFalse:[

            Dialog warn:(AbstractFileBrowser classResources 

                            string:'Failed to create directory: %1').

            ^ false

        ].

    ].

    aDirectory isDirectory ifFalse:[

        Dialog warn:'Not a directory: %1' with:aDirectory asString.

        ^ false

    ].

    ^ true

    "Created: / 07-02-2007 / 18:30:49 / cg"

    "Modified: / 09-12-2010 / 08:45:45 / cg"

    "Modified: / 10-07-2019 / 18:28:16 / Claus Gittinger"

!

fileExistsDialogForNewFile:newFile oldFile:oldFile withCancel:withCancel

    "return true, if the file should be moved/copied.

     Ask user if oldFile exists."

    ^ self fileExistsDialogForNewFile:newFile oldFile:oldFile withCancel:withCancel withRemoveIfSame:false.

!

fileExistsDialogForNewFile:newFile oldFile:oldFile withCancel:withCancel withRemoveIfSame:withRemoveIfSame

    "return true, if the file should be moved/copied.

     If oldFile exists, ask user.

     If withRemoveIfSame is true, two additional possible values are returned:

        #removeSource and #removeDestination.

    "

    ^ self

        fileExistsDialogForNewFile:newFile oldFile:oldFile withCancel:withCancel withRemoveIfSame:withRemoveIfSame

        withAllAction:false

    "Modified: / 20-03-2012 / 11:44:51 / cg"

!

fileExistsDialogForNewFile:newFile oldFile:oldFile withCancel:withCancel withRemoveIfSame:withRemoveIfSame withAllAction:withAllAction

    "return true, if the file should be moved/copied.

     If oldFile exists, ask user.

     If withRemoveIfSame is true, two additional possible values are returned:

        #removeSource and #removeDestination.

    "

    |msg oldSize newSize sameContents resources sourceType destType labels values default 

     forAllHolder answer oldFileIsDirectory newFileIsDirectory 

     oldFileTime newFileTime olderOrNewer 

     newFileSize oldFileSize smallerOrLarger|

    newFile exists ifFalse:[ ^ true ].

    oldSize := oldFile fileSize.

    newSize := newFile fileSize.

    sameContents := false.

    oldFileIsDirectory := oldFile isDirectory.

    newFileIsDirectory := newFile isDirectory.

    newFileIsDirectory ifTrue:[

        oldFileIsDirectory ifTrue:[

            "/ could (should?) recursively look for same contents here...

        ].

    ] ifFalse:[

        oldFileIsDirectory ifFalse:[

            sameContents := oldSize = newSize and:[oldFile sameContentsAs:newFile].

        ]

    ].

    resources := AbstractFileBrowser classResources.

    "/ for now:

    oldFileIsDirectory ~~ newFileIsDirectory ifTrue:[

        Dialog warn:(resources string:'Will not overwrite directory with file and vice versa.').

        ^  false.

    ].

    sourceType := newFileIsDirectory ifTrue:'directory' ifFalse:'file'.

    destType := oldFileIsDirectory ifTrue:'directory' ifFalse:'file'.

    sameContents ifTrue:[

        msg := 'Overwrite existing destination ',destType,':\\  %1\    size: %3 of %2\\with %8 source (same contents):\\  %4\    size: %6 of %5'.

    ] ifFalse:[

        msg := 'Overwrite existing destination ',destType,':\\  %1\    size: %3 of %2\\with %8 source (%9):\\  %4\    size: %6 of %5'.

    ].

    newFileTime := newFile modificationTime ? Timestamp now.

    oldFileTime := oldFile modificationTime ? Timestamp now.

    olderOrNewer := newFileTime < oldFileTime    

                    ifTrue:[ 'newer' ]

                    ifFalse:[ 'older' ].

    newFileSize := newFile fileSize.

    oldFileSize := oldFile fileSize.

    smallerOrLarger := newFileSize < oldFileSize    

                    ifTrue:[ 'larger' ]

                    ifFalse:[ 

                        newFileSize = oldFileSize 

                            ifTrue:['same size']

                            ifFalse:['smaller' ]].

    msg := resources

            stringWithCRs:msg

            withArguments:(Array

                with:newFile asString allBold

                with:(newFileTime printStringFormat:'%(Day)-%(mon)-%(year) %h:%m:%s')

                with:newSize

                with:oldFile asString allBold

                with:(oldFileTime printStringFormat:'%(Day)-%(mon)-%(year) %h:%m:%s')

                with:oldSize

                with:destType "/ file or directory - no longer used in template

                with:(resources string:olderOrNewer)

                with:(resources string:smallerOrLarger) ).

    (sameContents and:[withRemoveIfSame]) ifTrue:[

        labels := #( 'No' 'Remove Destination' 'Remove Source'  'Yes').

        values := #( false #removeDestination #removeSource true ).

        withCancel ifTrue:[ 

            labels := #('Cancel') , labels.

            values := #( nil ) , values. 

        ].

        default := #removeSource.

    ] ifFalse:[

        labels := #( 'No' 'Yes').

        values := #( false true ).

        withCancel ifTrue:[ 

            labels := #('Cancel') , labels.

            values := #( nil ) , values. 

        ].

        default := false.

    ].

    forAllHolder := false asValue.

    Dialog modifyingBoxWith:[:box |

        withAllAction ifTrue:[

            box addVerticalSpace:10.

            box verticalPanel 

                 add:(CheckBox 

                        label:(resources string:'Same action for all') 

                        model:forAllHolder).

        ].

    ] do:[

        answer := OptionBox

              request:msg

              label:(resources string:'Confirm overwrite existing file')

              image:(YesNoBox iconBitmap)

              buttonLabels:(resources array:labels)

              values:values

              default:default

              onCancel:nil.

    ].

    (withAllAction and:[answer notNil]) ifTrue:[

        forAllHolder value ifTrue:[

            actionForAll := answer

        ].

    ].

    ^ answer

    "Created: / 20-03-2012 / 11:44:34 / cg"

    "Modified: / 30-11-2017 / 14:20:27 / cg"

    "Modified: / 09-08-2018 / 14:57:53 / Claus Gittinger"

! !

!FileOperation methodsFor:'initialization'!

initialize

    result := false.

    "Created: / 30-11-2017 / 14:19:18 / cg"

! !

!FileOperation methodsFor:'queries'!

isErase

    ^ false

! !

!FileOperation::Copy class methodsFor:'actions'!

copyFile:aSourceFile to:aDestFile

    |instance|

    instance := self new.

    instance copyFile:aSourceFile to:aDestFile.

    ^ instance

!

copyFile:aSourceFile to:aDestFile withOverWriteWarning:overWriteWarning

    |instance|

    instance := self new.

    instance copyFile:aSourceFile to:aDestFile withOverWriteWarning:overWriteWarning.

    ^ instance

!

copyFile:aSourceFile to:aDestFile withOverWriteWarning:overWriteWarningBoolean copyFileIfSame:copyIfSameBoolean

    |instance|

    instance := self new.

    instance copyFile:aSourceFile to:aDestFile withOverWriteWarning:overWriteWarningBoolean copyFileIfSame:copyIfSameBoolean.

    ^ instance

!

copyFiles:aColOfSourceFiles to:aDirectory

    |instance|

    instance := self new.

    instance copyFiles:aColOfSourceFiles to:aDirectory.

    ^ instance

!

copyFiles:aColOfSourceFiles to:aDirectory withOverWriteWarning:overWriteWarning

    |instance|

    instance := self new.

    instance copyFiles:aColOfSourceFiles to:aDirectory withOverWriteWarning:overWriteWarning.

    ^ instance

!

copyFiles:aColOfSourceFiles to:aDirectory withOverWriteWarning:overWriteWarning copyFileIfSame:copy

    |instance|

    instance := self new.

    instance copyFiles:aColOfSourceFiles to:aDirectory withOverWriteWarning:overWriteWarning copyFileIfSame:copy.

    ^ instance

! !

!FileOperation::Copy methodsFor:'accessing'!

colOfCopiedFiles

    <resource: #obsolete>

    "obsolete - bad name"

    ^ self collectionOfCopiedFiles

!

collectionOfCopiedFiles

    copiedFiles isNil ifTrue:[

	copiedFiles := OrderedCollection new.

    ].

    ^ copiedFiles

!

collectionOfNewFiles

    newFiles isNil ifTrue:[

	newFiles := OrderedCollection new.

    ].

    ^ newFiles

! !

!FileOperation::Copy methodsFor:'actions'!

copyFile:aSourceFile to:aDestFile