de.frame4j

Class FS

java.lang.Object

de.frame4j.util.App

de.frame4j.FS

All Implemented Interfaces:

AttrSettable, TextHelper.MessageComponents, AppMBean, ComVar, UIInfo, ActionListener, EventListener

@MinDoc(copyright="Copyright 1997 - 2003, 2014, 2016  A. Weinert",
        author="Albrecht Weinert",
        version="V.44",
        lastModified="6.05.2021",
        usage="start as Java application (-? for help)",
        purpose="search files, sort and list; search doublets")
public class FS
extends App

Search files, sort and list; search doublets.

This application searches files and directories and detects doublets visiting one or more base directories and optionally their sub-directories. The selection criteria may be quite complex:
java FS \source\java;html;xml -omitDirs CVS;.svn;.settings -since 1.3.03 doc\html;xml -r

Criteria and options set (-omitDirs, -since and -r in above example) are valid for all files respectively directories no, matter what the parameter sequence "and mix " is. At the end the tool lists all matching files sorted by file names.

A search for file doublets is available too. This is a good first step for automated or hand crafted clean up campaigns. For any two files to be considered as equal by this tools at least two conditions must be met:

• the names (of course without the parent paths) and
• the file sizes must be equal.

Additionally any combination of the following criteria can be set as further equality condition

• the modification dates must be the same (default on).
• the content (byte by byte) must be equal (default off).

When generating a list of doublets (of files equal according to the chosen set of criteria) one file of every doublets group can be commented out on the list by option -keep. An (middle clever) algorithm tries do do as much "keeps" as possible in the same directories. If you feed the list generated this way even unmodified to the delete tool Era would keep exactly one file out of every doublet group and it would empty directories containing only doublets with significant probability (as one normally would like on clean up).

SVN repair

Another feature is the "Subversion modified date bug" repair mode switched on by option -svnRepair. Hereby the "listing" is generated additionally as a XML file containing an ANT task to restore the dates forgotten if (and only if) no further changes and commits were done to the file added.
The option -svnRepair sets the following properties:
pureName=false ## antTime=true ## equalsOnly = false ## relateToDir = true ## svnRepair = true ## omitDirs = .svn ## recursion=true
The behaviour of the repair mode is further governed by the following properties (listed with their default values):

    targetName = repairDates4SVN
    beforeDateName = firstCommit
    buildFileName = build.xml
    projectName = repair SVN's file modification time bug
    antCompareTimeFormat = m/d/Y h:i a
   afterFirstCeckInTime  (null defaults to 10 minutes after generation)
    antXMLencoding = ISO-8859-1
  

The property afterFirstCeckInTime is the criterion for changes and further check ins. For those (only) the modification time delivered by SVN can be considered as non-nonsense. This property may be set by the option
-addTime "yesterday noon" (e.g.)
in any form understood by Frame4J's time parsers.

A more canonical way to remedy SVN's modification date bug is to save (pre-commit, local) and restore (post-update, local) the last modified date as (SVN-) property. Save example:

 
    java FS -relateToDir -omitDirs .svn;build  -antTime |\
        grep "m " | \
     gawk '{print "svn propset mtime \"" $1 " " $2 " " $3 " \" "  $5 }'\
          > saveTheDate.bat
    call saveTheDate.bat
  

Restore example:

 
    svn propget mtime -R | \
      gawk '{print "touch -m --date=\"" $3 " " $4 " " $5 "\" "  $1 }'\
          > rescueTheDate.bat
    call  rescueTheDate.bat
  

Common examples

java FS .\+.class -r
lists all files *.class in the actual directory and all its subdirectories.

java FS C: -omitDirs WINNT -r
lists all files on drive C: in including all subdirectories (-r) with the exception of directories named WINNT (and its subs).

java FS D:\weinert\+.doc -e
lists all doublets (equal option -e) .doc files in the directory named (and of course subdirectories).

java FS +.java;+.asm -oneDay -d -r
lists all .java and .asm source files in the actual directory and its subdirectories modified within the last 24 hours.

java FS .\+.class P:\+.class -since 10.06.09 -til 12.06.09_13:00
lists all files *.class in the actual directory and in drive P's root modified between 10th on June 2009 00:00 and 12th of June 13:00. (13 = 1_PM for those who love ambiguous time of day indications).


Hint: To this application FS belongs (as an integral part) a .properties file named FS.properties.


© Copyright 1997 - 2003, 2005, 2009 Albrecht Weinert

See Also:

App, Prop, FileHelper

Nested Class Summary

Nested classes/interfaces inherited from interface de.frame4j.util.ComVar

ComVar.Impl

Field Summary

Fields

Modifier and Type	Field and Description
String	afterFirstCeckInTime The compare time.
String	antCompareTimeFormat Format of the compare time.
boolean	antTime No file attributes in listing except the time in ugly ANT format.
String	antXMLencoding Encoding of the output file.
String	beforeDateName Name of the time property when to repair file dates.
String	buildFileDir Directory of the output (build) file.
String	buildFileName Name of the output file.
boolean	contentCompare Regard also the content as criterion for file equality.
boolean	dateCompare Regard also the date as criterion for file equality.
String	directory First directory to be listed.
boolean	doSort Sort listing by names.
boolean	equalsOnly Regard only files with doublets.
boolean	keepOne Comment out one file out of every group of doublets.
boolean	listDirs List also sub-directories (like files).
String	projectName Name of the SVN bug repair project.
boolean	pureName Omit file attributes from listing.
boolean	quoteSpace Use / list quotes for filenames with spaces.
boolean	recursion List also files in sub-directories.
String	relateTo Make filenames relative to this directory specification.
boolean	relateToDir Make filenames relative to (first) directory to be listed.
boolean	svnRepair Repair the SVN bug to forget file modification time on add.
String	targetName Name of the generated ANT task.

Fields inherited from class de.frame4j.util.App

ano, appBase, appIO, appStartTime, appStartTimeMS, args, argsOrig, bgColor, err, fullClassName, help, icon, log, mainThread, myClass, myFrame, name, out, outMode, packName, prop, retCode, runFlag, shortClassName, title, verbose, verbosity

Fields inherited from interface de.frame4j.util.ComVar

AUTHOR, BLANK_STRING, cons, CONSOL_ENCODING, COPYRIGHT, D, D_NaN, D_NegInf, D_PosInf, EMPTY_INT_A, EMPTY_STRING, FILE_ENCODING, FRW_CLLD, FS, FSS, H, hasCons, HOST_IP, HOST_IPv4, HOST_NAME, INIT_ERROR, JAR_ENCODING, JH, JOB_DONE_OK, JRL, LOG_OUT_ERROR, M, MAIN_THREAD_EXC, NO_BYTES, NO_CLASSES, NO_DOUBLES, NO_OBJECTS, NO_PARS_ERROR, NO_STRINGS, NOT_WINDOWS, ON_PI, ONE_DAY, ONE_HOUR, ONE_LEAP_YEAR, ONE_MINUTE, ONE_SECOND, ONE_WEEK, ONE_YEAR, OS, PROG_NAME, PROG_SHORT, PS, RUNTIME, S, SHY, UD, UL, UL_UR_da, UR

Fields inherited from interface de.frame4j.net.AttrSettable

ILLEGAL_TYPE, ILLEGAL_VALUE, NO_ATTRIBUTE, NO_KNOWN_ATTRIBUTE, NO_VALUE, OK, retVtext

Constructor Summary

Constructors

Constructor and Description
FS()

Method Summary

Modifier and Type	Method and Description
int	doIt() Working method of FS.
static void	main(String[] args) Start method of FS.
boolean	parsePartial() FS wants just only partial parameter parsing by Prop.
protected int	setAttribute(String name, char name0, Object value, Class<?> vClass, boolean isNull, boolean isStringVal) Overridable implementation of setAtttibute(String, Object).
static StringBuilder	touchTask(StringBuilder bastel, CharSequence fileName, CharSequence uglyAntTime, CharSequence antCompTime) Make an ANT touch task, optionally conditional.

Methods inherited from class de.frame4j.util.App

actionPerformed, allowNoPropertiesFile, clientOrder, condHelpLog, connect, errMeld, errMeld, errorExit, errorExit, errorText, extraPropertiesFile, formMessage, formMessage, formMessage, getAbout, getAboutText, getActTime, getAppLogger, getAppStartTime, getArgs, getAuthor, getCopyright, getDbLogger, getExecTimeMs, getExecTimeMsL, getExecTimeString, getHelp, getHelpText, getIcon, getLanguage, getLogHandler, getMessageComponent, getMessageComponentsLength, getMyFrame, getName, getNameWithVersDate, getOutMode, getProp, getPurpose, getStartTime, getStateString, getTheCloser, getTitle, getUsage, getVerbose, getVerbosity, getVersDate, go, go, go, haveIcon, isDebug, isHelp, isHelpLog, isNormal, isRunFlag, isSilent, isTest, isVerbose, logVerbose, logVerbose, makeStatusTextEnd, makeStatusTextStart, messageFormat, normalExit, performeAction, queueAction, regAsStdMBean, repExc, setAboutText, setAttribute, setAuthor, setBgColor, setCodePages, setCopyright, setHelp, setLogOut2, setName, setOutMode, setOutMode, setPurpose, setTitle, setUsage, setVerbose, setVerbose, setVerbosity, setVerbosity, setVersDate, stop, threeLineEndMsg, toString, twoLineEndMsg, twoLineStartMsg, valueLang, valueLang, wakeMainThread

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.frame4j.net.AttrSettable

retVtext

Field Detail

directory

public String directory

First directory to be listed.

Appended to the directory path can be file denotations that may use wildcards or type lists:
..\tmp\+.j+ (+ used instead of *) ..\tmp\class;bak;tmp;obj;map

There may be multiple parameters of that form in the start parameters then worked on sequentially.

default: ".\+.+"; without specifying anything "all in the actual directory" (see ComVar.UD) is assumed.

listDirs

public boolean listDirs

List also sub-directories (like files).

If true sub-directories matching the file [sic!] criteria are put in the file list.

Don't intermix this with recursive (recursion) descend to sub-directories and the with directory criteria used to select the sub-directories to be visited.

default: false

recursion

public boolean recursion

List also files in sub-directories.

If true sub-directories matching the directory criteria will be visited and their files (matching the file criteria) will be listed (and later worked on, sorting, doublet search or what else).

default: false

equalsOnly

public boolean equalsOnly

Regard only files with doublets.

If true, after collecting (and sorting) all files will be removed from the file list, that do not have at least one other equal file (in another directory).

If this property is true and only one (base) directory is specified recursion will be set true.

If svnRepair is true and more than one directory is specified this property equalsOnly will be set true. ANT touch entries will only generated (relative to and) only for files of the first directory, if that file (same name and size) has a sibling in another directory. The oldest date of all those equal files will be taken as the set date.

default: false

quoteSpace

public boolean quoteSpace

Use / list quotes for filenames with spaces.

If this property is true files containing spaces within their (full) name will have that in quotes on the list output.

default: true (makes sense as Windows file system allows spaces in names)

dateCompare

public boolean dateCompare

Regard also the date as criterion for file equality.

If true only files with the same last modification time (file system's time stamp) may be considered as equal. The default is true.
If files on different computers or ones copied to removable media are considered false is often the better choice (option -ndc).

default: true

See Also:

equalsOnly, svnRepair

contentCompare

public boolean contentCompare

Regard also the content as criterion for file equality.

If true only files with the same content in all bytes may be considered as equal. This implies dateCompare = false.

default: false

keepOne

public boolean keepOne

Comment out one file out of every group of doublets.

If true one file out of every doublet group is commented out on the file list (using /// ).

The list can be fed directly / unmodified to the tool Era to have the maximum clean up effect without loosing any content.

default: false

pureName

public boolean pureName

Omit file attributes from listing.

If true only the name appears on the file list output, no length, no date or else.

default: false

relateTo

public String relateTo

Make filenames relative to this directory specification.

This property must either be null or denote an existing directory and end with ComVar.FS (to make the kind clear).

If set all full file names will be shortened by that prefix, leaving a file denotation relative to the directory relateTo.

default: null, but set to first specified directory in case of relateToDir is true.

relateToDir

public boolean relateToDir

Make filenames relative to (first) directory to be listed.

If true relateTo will be set to directory.

No effect in case of doublets search etc.

default: false

See Also:

svnRepair

antTime

public boolean antTime

No file attributes in listing except the time in ugly ANT format.

If true only the name (without length and else) will be output, preceded (yes in front!) by the time in the disgusting time format ANT's touch task requires.

Implies pureName in the said sense and sets quoteSpace false.

default: false

See Also:

TimeHelper.format(CharSequence, java.time.ZonedDateTime)

doSort

public boolean doSort

Sort listing by names.

If true the list is sorted by (pure) file names. That is default and (forced) precondition for doublets search etc.

default: true.

svnRepair

public boolean svnRepair

Repair the SVN bug to forget file modification time on add.

If true the "listing" format is an ANT task to repair the (very) hard SVN bug to set the file dates of a file added to the commit time.

default: false

See Also:

equalsOnly

targetName

public String targetName

Name of the generated ANT task.

default: repairDates4SVN

See Also:

svnRepair, projectName

beforeDateName

public String beforeDateName

Name of the time property when to repair file dates.

The value has to be in the ugly American ANT time format without seconds.

default: firstCommit

See Also:

svnRepair, antCompareTimeFormat

buildFileName

public String buildFileName

Name of the output file.

default: build.xml

See Also:

svnRepair, projectName, antXMLencoding, buildFileDir

buildFileDir

public String buildFileDir

Directory of the output (build) file.

default: null (means use the first directory scanned and related to)

See Also:

svnRepair, buildFileName

antXMLencoding

public String antXMLencoding

Encoding of the output file.

default: ISO-8859-1

See Also:

svnRepair, buildFileName

projectName

public String projectName

Name of the SVN bug repair project.

See Also:

svnRepair, targetName

antCompareTimeFormat

public String antCompareTimeFormat

Format of the compare time.

default: m/d/Y h:i a

See Also:

svnRepair, beforeDateName, afterFirstCeckInTime, TimeHelper.format(CharSequence, java.time.ZonedDateTime)

afterFirstCeckInTime

public String afterFirstCeckInTime

The compare time.

default: null (will be made 10 minutes after run time)

See Also:

svnRepair, beforeDateName, antCompareTimeFormat

Constructor Detail

FS

public FS()

Method Detail

parsePartial

public boolean parsePartial()

FS wants just only partial parameter parsing by Prop.

Overrides:

parsePartial in class App

Returns:

false except when made by the make'n go constructor App(String[])

main

public static void main(String[] args)

Start method of FS.

Return-Code:
Exit = 0 on success,
Exit > 0 on (file) problems,
Exit > 90 on wrong parameters.

Parameters:

args - command line parameter

setAttribute

protected int setAttribute(String name,
                           char name0,
                           Object value,
                           Class<?> vClass,
                           boolean isNull,
                           boolean isStringVal)

Description copied from class: App

Overridable implementation of setAtttibute(String, Object).

This method will be called by App.setAttribute(name, value) for all name value pairs not clearly handled or rejected by said App's method. In this call all parameters are correct and the parameter value is converted to String if it was (only) of type CharSequence.

Hint: The gain (for the prize of 6 parameters) is that all preliminaries, and checks otherwise necessary (if directly overriding App.setAttribute(String, Object)) are superfluous here.
Hint2: Not overriding either would have no effect except for start-up performance. App and PropMap would do the same job using introspection.

Overrides:

setAttribute in class App

Parameters:

name - name of the property (never empty)

name0 - first character of name (>= a)

value - the (new) value of the property

vClass - the (original) class of value (or null if isNull)

isNull - true if value is null

isStringVal - true if value is of type String

Returns:

AttrSettable.NO_KNOWN_ATTRIBUTE

See Also:

AttrSettable, AttrSettable.ILLEGAL_TYPE, AttrSettable.ILLEGAL_VALUE, AttrSettable.NO_VALUE, AttrSettable.OK

doIt

public int doIt()

Working method of FS.

Specified by:

doIt in class App

Returns:

the exit code; 0 means OK

See Also:

Prop, App.go(String[]), App.go(String[], String, CharSequence), App.mainThread

touchTask

public static StringBuilder touchTask(StringBuilder bastel,
                                      CharSequence fileName,
                                      CharSequence uglyAntTime,
                                      CharSequence antCompTime)

Make an ANT touch task, optionally conditional.

Parameters:

bastel - the StringBuilder to append to, if null one is made

fileName - the name / designation of the file to touch

uglyAntTime - the time to set to in ANT / American format

antCompTime - the optional compare time (same ugly w/o seconds)
null means unconditional touch / time set

Returns:

bastel