"

 COPYRIGHT (c) 1995 by Claus Gittinger

	      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.

"

AbstractSourceCodeManager subclass:#CVSSourceCodeManager

	 instanceVariableNames:''

	 classVariableNames:'Verbose CVSRoot'

	 poolDictionaries:''

	 category:'System-Support'

!

!CVSSourceCodeManager class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1995 by Claus Gittinger

	      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

"

    SourceCodeManager which accesses sourcecode through cvs.

    It requires the shell environment variable CVSROOT to be set

    to the top of the repository tree. Under that top, for each module

    (especially the stx module itself), a subdirectory containing that modules

    directories must exist.

    If not specified otherwise, the module defaults to 'stx'. 

    If a class has its home in another module, it has to be compiled

    with a corresponding entry in the package string (see below).

    Within a module, classes are organized in classlibraries, and the corresponding

    source code is found in various subdirectories of CVSROOT. The directories

    name can also be provided by the package string - if not, it defaults to the

    libraries name.

    The package string controls all this, and is REQUIRED in order for the sourceCodeManager

    to be able to retrieve a classes source.

    The package strings format is:

	'...any infotext....(sourceCodeInfo)'

    the sourceCOdeInfo consists of multiple entries, separated by colons.

    The following formats are allowed:

	(libraryName)                   - module defaults to 'stx'; directory to the name of the library

	(foo/bar/x)                     - module defaults to 'stx'; dir is 'foo/bar/x'; library name defaults to x

	(module:directory:libname)      - specifies all components

    The first formats are intermediate, for backward compatibility. We urge everyone

    to use the last format (by changing the Make.proto files and add a -P flag to

    the stc compiler flags (see libbasic/Make.proto as an example).

    Notice, that the sourceCodeManager is (currently) only consulted, if no

    source subdirectory exists, or no source file is found there. If it does exist,

    that one is supposed to contain an up-to-date version of the classes source

    (this is temporary - in the future the probe order will be reversed, trying

     the source repository first).

    The source directory is required for systems which do NO source code control.

    Setup:

	- make certain, that the commands 'cvs' and 'co' are available on your system.

	- add setup for the CVSROOT environment variable to your .bashrc / .login / .profile

	- Make certain that either no local source directory exists, or it is empty or it contains

	  only source code for files NOT found in the repository (this will not be required in future versions).

    Caveat:

	currently, the rcs container is accessed directly, since cvs mangles the files ident-string and

	thus does not correctly recreate the original file (all source is offset by some characters w.r.t. the

	compiled file).

	Therefore, sevrer-mode CVS is not supported.

"

!

version

!CVSSourceCodeManager class methodsFor:'initialization'!

initialize

    "/

    "/ if CVSROOT is non-empty and both cvs and co are available

    "/ as commands, assume this system uses a cvs source code management.

    "/

    (CVSRoot := OperatingSystem getEnvironment:'CVSROOT') notNil ifTrue:[

	(OperatingSystem canExecuteCommand:'cvs') ifTrue:[

	    (OperatingSystem canExecuteCommand:'co') ifTrue:[

		self initCacheDirPath.

		Smalltalk at:#SourceCodeManager put:self.

		'CVS SourceCodeManager installed.' infoPrintNL.

	    ]

	]

    ]

    "

     CVSSourceCodeManager initialize

    "

    "Created: 4.11.1995 / 19:14:38 / cg"

! !

!CVSSourceCodeManager class methodsFor:'source code access'!

checkinClass:cls fileName:classFileName directory:packageDir module:moduleDir source:sourceFileName logMessage:logMessage

    "enter a classes source code (which has been already filed out into sourceFileName)

     into the source repository.

     Return true if ok, false if not."

merge := false. "/ for now ....

    merge ifTrue:[

	revision := cls revision.

	revision isNil ifTrue:[ 

	    'CVSMGR: class ' , cls name , ' has no revision string' infoPrintNL.

	    ^ nil.

	].

    ].

    logMsg := logMessage.

    (logMsg isNil or:[logMsg isEmpty]) ifTrue:[

	logMsg := 'checkin from browser'.

    ].

    "/

    "/ in CVS, we have to checkout the file first, in order

    "/ to get up-to-date CVS entries, and also to be able to merge in

    "/ other users changes.

    "/

    "/

    "/ first, create a temporary work tree

    "/

    tempdir := Filename newTemporaryIn:nil.

    tempdir exists ifTrue:[

	tempdir recursiveRemove.

    ].

    tempdir makeDirectory.

    dir := tempdir construct:moduleDir.

    dir makeDirectory.

    dir := dir construct:packageDir.

    dir makeDirectory.

    "/

    "/ check it out there

    "/

    checkoutName :=  moduleDir , '/' , packageDir , '/' , classFileName , '.st'.

    merge ifTrue:[

    ] ifFalse:[

	cmd := 'cd ' , tempdir name , ';cvs checkout ' , checkoutName.

    ].

    (OperatingSystem executeCommand:cmd) ifFalse:[

'failed: ' errorPrint. cmd errorPrintNL.

	tempdir recursiveRemove.

	('CVSMGR: cannot checkout ' , checkoutName) errorPrintNL.

	^ false.

    ].

    "/

    "/ copy-over our current version

    "/

    cmd := 'mv ' , sourceFileName , ' ' , tempdir name , '/' , checkoutName.

    (OperatingSystem executeCommand:cmd) ifFalse:[

'failed: ' errorPrint. cmd errorPrintNL.

	'CVSMGR: cannot copy-over filedOut class source' errorPrintNL.

	^ false.

    ].

    "/

    "/ now check it in again

    "/

    cmd := 'cd ' , tempdir name , ';cvs commit -m "', logMsg ,'" ' .

    (OperatingSystem executeCommand:cmd) ifFalse:[

'failed: ' errorPrint. cmd errorPrintNL.

	'CVSMGR: cannot checkin modified class source' errorPrintNL.

	^ false.

    ].

    tempdir recursiveRemove.

    ^ true

    "

    "

    "Created: 6.11.1995 / 18:57:05 / cg"

!

streamForClass:cls fileName:classFileName revision:revision directory:packageDir module:moduleDir cache:cacheIt

    "extract a source file and return an open readStream on it."

    |dir cachedSourceFilename temporaryFile file cmd fullName revisionArg stream|

    CVSRoot isNil ifTrue:[

	'CVSMGR: CVSROOT not set' infoPrintNL.

	^ nil

    ].

    "/ if not already existing, create a temp directory

    "/ where we deposit sources.

    "/ this is used as a cache for further requests, since

    "/ accessing the repository may be slow.

    "/ (if cvs uses a remote connection via ppp, for example)

    "/

    (dir := self sourceCacheDirectory) isNil ifTrue:[

	^ nil

    ].

    fullName := moduleDir , '/' , packageDir , '/' , classFileName , '.st'.

    (revision isNil or:[revision == #newest]) ifTrue:[

	cachedSourceFilename := classFileName.

    ] ifFalse:[

	cachedSourceFilename := classFileName , '_' , revision.

    ].

    file := (dir construct:cachedSourceFilename) asFilename.

    file exists ifTrue:[

"/        ('CVSMGR: found existing: ', file name) infoPrintNL.

    ] ifFalse:[

	"/

	"/ ok, ask cvs to extract the corresponding source code

	"/ into the cache directory ...

	"/

	"/ claus: cannot use 'cvs' (it mangles the header's filename string

	"/        by expanding symbolic links). This may make the extracted files

	"/        contents different from the compiled one and thus invalidates the

	"/        methods source-offsets.

	"/        By directly calling 'co', this trouble goes away.

	"/

	temporaryFile := (Filename newTemporaryIn:nil) name.

	(revision isNil or:[revision == #newest]) ifTrue:[

	    revisionArg := ''

	] ifFalse:[

	    revisionArg := '-r' , revision

	].

	cmd := '(cd ' , CacheDirectoryName , '; co -q ' , revisionArg , ' -p ' , CVSRoot , '/' , fullName , ' > ' , temporaryFile , ')'.

	Verbose == true ifTrue:[

	    ('CVSMGR: executing: ' , cmd ) infoPrintNL.

	].

	(OperatingSystem executeCommand:cmd) ifFalse:[

	    'CVSMGR: checkout failed' infoPrintNL.

	    ^ nil

	].

	cacheIt ifTrue:[

	    (OperatingSystem renameFile:(CacheDirectoryName , '/' , temporaryFile)

			     to:(CacheDirectoryName , '/' , cachedSourceFilename)) ifFalse:[

		('CVSMGR: failed to rename ', temporaryFile, ' to ', cachedSourceFilename) infoPrintNL.

		^ nil

	    ]

	] ifFalse:[

	    stream := (CacheDirectoryName , '/' , temporaryFile) asFilename readStream.

	    OperatingSystem removeFile:(CacheDirectoryName , '/' , temporaryFile).

	    ^ stream

	]

    ].

    ^ file readStream

    "Created: 4.11.1995 / 19:46:20 / cg"

    "Modified: 9.11.1995 / 14:32:55 / cg"

! !

!CVSSourceCodeManager class methodsFor:'source code administration'!

    CVSRoot isNil ifTrue:[

	'CVSMGR: CVSROOT not set' infoPrintNL.

	^ nil

    ].

    fullName := CVSRoot , '/' , moduleDir , '/' , packageDir , '/' , classFileName , '.st,v'.

    file := fullName asFilename.

    file exists ifFalse:[

	('CVSMGR: non existing repository file: ', file name) infoPrintNL.

	^ false

    ].

    inStream isNil ifTrue:[

	('CVSMGR: cannot open pipe to rlog ', file name) infoPrintNL.

	^ false

    ].

    skip := true.

    [skip and:[inStream atEnd not]] whileTrue:[

	line:= inStream nextLine.

    ].

    inStream nextLine. "/ skip separating line.

    atEnd := false.

    [atEnd or:[inStream atEnd]] whileFalse:[

	revLine1 := inStream nextLine.

	revLine2 := inStream nextLine.

	(idx := revLine2 indexOfSubCollection:'state:') ~~ 0 ifTrue:[

	    revLine2 := revLine2 copyTo:idx - 1

	].

	aStream cr.

	aStream nextPutAll:revLine1; nextPutAll:'    '.

	aStream nextPutAll:revLine2; cr.

	line := inStream nextLine.

	[atEnd or:[line startsWith:'--------']] whileFalse:[

	    (line startsWith:'==========') ifTrue:[

		atEnd := true.

	    ] ifFalse:[

		(line withoutSpaces = '.') ifTrue:[

		    line := '*** empty log message ***'

		].

		aStream nextPutAll:'    '; nextPutAll:line; cr.

		line := inStream nextLine.

	    ]

	]

    ].

    inStream close.

    ^ true

    "Created: 16.11.1995 / 13:25:30 / cg"

! !

CVSSourceCodeManager initialize!