gnustep/libs-ec
0
0
Fork 0
mirror of https://github.com/gnustep/libs-ec.git synced 2025-02-20 18:32:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix bug in archiving and simplify code

Browse source
This commit is contained in:
Richard Frith-Macdonald 2017-06-23 11:26:17 +01:00
parent b4c1c3c320
commit 291b295089
5 changed files with 173 additions and 186 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
ChangeLog
View file

@ -1,3 +1,14 @@
2017-06-23 Richard Frith-Macdonald <rfm@gnu.org>
* EcCommand.m:
* EcControl.m:
* EcProcess.h:
* EcProcess.m:
Replace cmdArchive: with ecArchive: changing trhe log file archiving
model to archive files primarily based on their last modification
date. Fixes the bug where files were archived to a folder with the
wrong datre on startup, and simplifies archiving code generally.
2017-03-06 Richard Frith-Macdonald <rfm@gnu.org>
* EcAlarmDestination.h:

11
EcCommand.m
View file

@ -752,16 +752,7 @@ static NSString* cmdWord(NSArray* a, unsigned int pos)
}
else if (comp(wd, @"archive") >= 0)
{
NSCalendarDate *when = [NSCalendarDate date];
NSString *sub;
int yy, mm, dd;
yy = [when yearOfCommonEra];
mm = [when monthOfYear];
dd = [when dayOfMonth];
sub = [NSString stringWithFormat: @"%04d-%02d-%02d", yy, mm, dd];
m = [NSString stringWithFormat: @"\n%@\n\n", [self cmdArchive: sub]];
m = [NSString stringWithFormat: @"\n%@\n\n", [self ecArchive: nil]];
}
else if (comp(wd, @"help") >= 0)
{

11
EcControl.m
View file

@ -798,16 +798,7 @@ static NSString* cmdWord(NSArray* a, unsigned int pos)
}
else if (comp(wd, @"archive") >= 0)
{
NSCalendarDate *when = [NSCalendarDate date];
NSString *sub;
int yy, mm, dd;
yy = [when yearOfCommonEra];
mm = [when monthOfYear];
dd = [when dayOfMonth];
sub = [NSString stringWithFormat: @"%04d-%02d-%02d", yy, mm, dd];
m = [NSString stringWithFormat: @"\n%@\n\n", [self cmdArchive: sub]];
m = [NSString stringWithFormat: @"\n%@\n\n", [self ecArchive: nil]];
}
else if (comp(wd, @"clear") >= 0)
{

28
EcProcess.h
View file

@ -570,12 +570,12 @@ extern NSString* cmdVersion(NSString *ver);
*/
- (void) cmdAlert: (NSString*)fmt, ... NS_FORMAT_FUNCTION(1,2);
/** Archives debug log files into the specified subdirectory of the debug
* logging directory. If subdir is nil then a subdirectory name corresponding
* to the current date is generated and that subdirectory is created if
* necessary.
/** Archives debug log files into the appropriate subdirectory for the
* supplied date (or the files last modification date if when is nil).<br />
* Returns a text description of any archiving actually done.<br />
* The subdirectory is created if necessary.
*/
- (NSString*) cmdArchive: (NSString*)subdir;
- (NSString*) ecArchive: (NSDate*)when;
/** Send a log message to the server.
*/
@ -662,10 +662,12 @@ extern NSString* cmdVersion(NSString *ver);
*/
- (BOOL) cmdIsTesting;
/** Closes a file handle previously obtained using the -cmdLogFile: method.
/** Closes a file previously obtained using the -cmdLogFile: method.<br />
* Returns a description of any file archiving done, or nil if the file
* dis not exist.<br />
* You should not close a logging handle directly, use this method.
*/
- (void) cmdLogEnd: (NSString*)name;
- (NSString*) cmdLogEnd: (NSString*)name;
/** Obtain a file handle for logging purposes. The file will have the
* specified name and will be created (if necessary) in the processes
@ -920,8 +922,10 @@ extern NSString* cmdVersion(NSString *ver);
* It's therefore recommended that you use 'lazy' initialisation of subclass
* instance variables as/when they are needed, rather than initialising
* them in the -initWithDefaults: method.<br />
* An alternative strategy is to perform subclass initialisaton before
* calling the superclass implementation.
* For a normal process, the recommended place to perform initialisation is
* immediately after initialisation (when configuration information has been
* retrieved from the Command server), typically by overriding the
* -ecRun method.
*/
- (id) initWithDefaults: (NSDictionary*)defs;
@ -1031,7 +1035,11 @@ extern NSString* cmdVersion(NSString *ver);
/** Establishes the receiver as a DO server and runs the runloop.<br />
* Returns zero when the run loop completes.<br />
* Returns one (immediately) if the receiver is transent.<br />
* Returns two if unable to register as a DO server.
* Returns two if unable to register as a DO server.<br />
* This is the recommended location to perform any initialisation of your
* subclass which needs configuration information from the Command server;
* override this method, perform your initialisation, and then call the
* superclass implementation of the method to enter the run loop.
*/
- (int) ecRun;

298
EcProcess.m
View file

@ -1038,7 +1038,7 @@ findMode(NSDictionary* d, NSString* s)
- (void) cmdMesgrelease: (NSArray*)msg;
- (void) cmdMesgtesting: (NSArray*)msg;
- (void) _memCheck;
- (NSString*) _moveLog: (NSString*)name to: (NSString*)sub;
- (NSString*) _moveLog: (NSString*)name to: (NSDate*)when;
- (void) _timedOut: (NSTimer*)timer;
- (void) _update: (NSMutableDictionary*)info;
@end
@ -1496,67 +1496,48 @@ static NSString *noFiles = @"No log files to archive";
return [dateClass dateWithTimeIntervalSinceReferenceDate: lastOP];
}
- (void) cmdLogEnd: (NSString*)name
- (NSString*) cmdLogEnd: (NSString*)name
{
NSFileHandle *hdl;
NSString *status = nil;
if ([name length] == 0)
{
NSLog(@"Attempt to end log with empty filename");
return;
}
name = [name lastPathComponent];
[self ecDoLock];
hdl = [cmdLogMap objectForKey: name];
if (hdl != nil)
else
{
NSString *path;
NSDictionary *attr;
NSFileManager *mgr;
NSFileHandle *hdl;
/* Ensure that all data is written to file, then close it unless it's
* stderr (which we must keep open for logging at all times).
*/
fflush(stderr);
if ([hdl fileDescriptor] != 2)
name = [name lastPathComponent];
[self ecDoLock];
hdl = [cmdLogMap objectForKey: name];
if (hdl != nil)
{
NS_DURING
[hdl closeFile];
NS_HANDLER
NS_ENDHANDLER
/* If the file is empty, remove it, otherwise archive it.
*/
status = [self _moveLog: name to: nil];
/* Ensure that all data is written to file, then close it unless it's
* stderr (which we must keep open for logging at all times).
*/
fflush(stderr);
if ([hdl fileDescriptor] != 2)
{
NS_DURING
[hdl closeFile];
NS_HANDLER
NS_ENDHANDLER
}
/*
* Unregister filename.
*/
[cmdLogMap removeObjectForKey: name];
}
/*
* If the file is empty, remove it, otherwise move to archive directory.
*/
path = [cmdLogsDir(nil) stringByAppendingPathComponent: name];
mgr = [NSFileManager defaultManager];
attr = [mgr fileAttributesAtPath: path traverseLink: NO];
if ([[attr objectForKey: NSFileSize] intValue] == 0)
{
[mgr removeFileAtPath: path handler: nil];
}
else
{
NSDate *when;
NSString *where;
when = [NSDate date];
where = [when descriptionWithCalendarFormat: @"%Y-%m-%d"
timeZone: nil locale: nil];
if (where != nil)
{
[self _moveLog: name to: where];
}
}
/*
* Unregister filename.
*/
[cmdLogMap removeObjectForKey: name];
[self ecUnLock];
}
[self ecUnLock];
return status;
}
- (NSFileHandle*) cmdLogFile: (NSString*)name
@ -1572,28 +1553,16 @@ static NSString *noFiles = @"No log files to archive";
name = [name lastPathComponent];
[self ecDoLock];
hdl = [cmdLogMap objectForKey: name];
if (hdl == nil)
if (nil == hdl)
{
NSFileManager *mgr = [NSFileManager defaultManager];
NSString *path;
path = [cmdLogsDir(nil) stringByAppendingPathComponent: name];
if ([mgr fileExistsAtPath: path] == YES)
{
NSDictionary *attr;
NSDate *when;
NSString *where;
attr = [mgr fileAttributesAtPath: path traverseLink: NO];
when = [attr objectForKey: NSFileModificationDate];
where = [when descriptionWithCalendarFormat: @"%Y-%m-%d"
timeZone: nil locale: nil];
if (where != nil)
{
status = [self _moveLog: name to: where];
}
}
/* Archive any old left-over file.
*/
[self _moveLog: name to: nil];
/*
* Create the file if necessary, and open it for updating.
@ -1941,7 +1910,7 @@ NSLog(@"Ignored attempt to set timer interval to %g ... using 10.0", interval);
va_end (ap);
}
- (NSString*) cmdArchive: (NSString*)subdir
- (NSString*) ecArchive: (NSDate*)when
{
NSString *status = @"";
@ -1957,27 +1926,18 @@ NSLog(@"Ignored attempt to set timer interval to %g ... using 10.0", interval);
[self ecDoLock];
enumerator = [[cmdLogMap allKeys] objectEnumerator];
[self ecUnLock];
if (subdir == nil)
{
NSCalendarDate *when = [NSCalendarDate date];
int y, m, d;
y = [when yearOfCommonEra];
m = [when monthOfYear];
d = [when dayOfMonth];
subdir = [stringClass stringWithFormat: @"%04d-%02d-%02d", y, m, d];
}
while ((name = [enumerator nextObject]) != nil)
{
NSString *s;
s = [self _moveLog: name to: subdir];
if ([status length] > 0)
status = [status stringByAppendingString: @"\n"];
status = [status stringByAppendingString: s];
[self cmdLogEnd: name];
s = [self cmdLogEnd: name];
if (nil != s)
{
if ([status length] > 0)
status = [status stringByAppendingString: @"\n"];
status = [status stringByAppendingString: s];
}
if (cmdIsQuitting == NO)
{
[self cmdLogFile: name];
@ -2320,32 +2280,34 @@ NSLog(@"Ignored attempt to set timer interval to %g ... using 10.0", interval);
- (void) ecNewDay: (NSCalendarDate*)when
{
static NSDictionary *defs = nil;
NSString *sub;
NSDictionary *d;
NSEnumerator *e;
NSString *k;
NSDictionary *d = [cmdDefs volatileDomainForName: @"EcCommand"];
/* New day ... archive debug/log files into a subdirectory based on
* the current date. This is yesterday's debug, so we use yesterday.
*/
sub = [[when dateByAddingYears: 0 months: 0 days: -1 hours: 0 minutes: 0
seconds: 0] descriptionWithCalendarFormat: @"%Y-%m-%d"];
NSLog(@"%@", [self cmdArchive: sub]);
/* Check information left in the EcCommand domain.
*/
d = [cmdDefs volatileDomainForName: @"EcCommand"];
e = [[d allKeys] objectEnumerator];
while (nil != (k = [e nextObject]))
if (nil != defs)
{
id v = [d objectForKey: k];
NSEnumerator *e;
NSString *k;
if ([v isEqual: [defs objectForKey: k]])
/* Archive previous day's logs. Force logs to be archived for the
* specified date even if they have been modified today (on the basis
* that only the very latest info in them should be from today).
*/
NSLog(@"%@", [self ecArchive: when]);
/* Check information left in the EcCommand domain.
*/
e = [[d allKeys] objectEnumerator];
while (nil != (k = [e nextObject]))
{
[self cmdError: @"The Console defaults override for '%@'"
@" has been left at '%@' for more than a day."
@" Please reset it ('tell %@ defaults delete %@') after updating"
@" Control.plist as required.", k, v, [self cmdName], k];
id v = [d objectForKey: k];
if ([v isEqual: [defs objectForKey: k]])
{
[self cmdError: @"The Console defaults override for '%@'"
@" has been left at '%@' for more than a day."
@" Please reset it ('tell %@ defaults delete %@') after"
@" updating Control.plist as required.",
k, v, [self cmdName], k];
}
}
}
ASSIGNCOPY(defs, d);
@ -2855,7 +2817,7 @@ NSLog(@"Ignored attempt to set timer interval to %g ... using 10.0", interval);
}
else
{
[self cmdPrintf: @"\n%@\n", [self cmdArchive: nil]];
[self cmdPrintf: @"\n%@\n", [self ecArchive: nil]];
}
}
}
@ -4309,7 +4271,7 @@ With two parameters ('maximum' and a number),\n\
/*
* Force archiving of old logfile.
*/
[self cmdArchive: nil];
[self ecArchive: nil];
ASSIGNCOPY(cmdDebugName, str);
hdl = [self cmdLogFile: cmdDebugName];
@ -4592,7 +4554,7 @@ With two parameters ('maximum' and a number),\n\
}
}
- (void)_ensureMemLogger
- (void) _ensureMemLogger
{
NSString *bundle = [cmdDefs stringForKey: @"MemoryLoggerBundle"];
Class cls = Nil;
@ -4843,65 +4805,89 @@ With two parameters ('maximum' and a number),\n\
}
}
- (NSString*) _moveLog: (NSString*)name to: (NSString*)sub
- (NSString*) _moveLog: (NSString*)name to: (NSDate*)when
{
NSString *status;
NSString *where;
NSString *status = nil;
NS_DURING
{
where = cmdLogsDir(sub);
if (where != nil)
{
NSFileManager *mgr = [NSFileManager defaultManager];
NSString *from;
NSString *path;
NSString *base;
NSString *gzpath;
unsigned count = 0;
NSFileManager *mgr = [NSFileManager defaultManager];
NSString *from;
NSDictionary *attr;
path = [where stringByAppendingPathComponent: name];
from = [cmdLogsDir(nil) stringByAppendingPathComponent: name];
from = [cmdLogsDir(nil) stringByAppendingPathComponent: name];
attr = [mgr fileAttributesAtPath: from traverseLink: NO];
if (nil != attr)
{
if ([[attr objectForKey: NSFileSize] intValue] == 0)
{
[mgr removeFileAtPath: from handler: nil];
status = [NSString stringWithFormat:
@"Removed empty log %@", from];
}
else
{
NSString *where;
NSString *sub;
/*
* Check for pre-existing file - if found, try another.
*/
base = path;
path = [base stringByAppendingPathExtension: @"0"];
gzpath = [path stringByAppendingPathExtension: @"gz"];
while ([mgr fileExistsAtPath: path] == YES
|| [mgr fileExistsAtPath: gzpath] == YES)
{
NSString *ext;
if (nil == when)
{
when = [attr fileModificationDate];
}
sub = [when descriptionWithCalendarFormat: @"%Y-%m-%d"
timeZone: nil
locale: nil];
where = cmdLogsDir(sub);
if (where != nil)
{
NSString *path;
NSString *base;
NSString *gzpath;
unsigned count = 0;
ext = [stringClass stringWithFormat: @"%u", ++count];
path = [base stringByAppendingPathExtension: ext];
gzpath = [path stringByAppendingPathExtension: @"gz"];
}
path = [where stringByAppendingPathComponent: name];
if ([mgr movePath: from
toPath: path
handler: nil] == NO)
{
status = [NSString stringWithFormat:
@"Unable to move %@ to %@", from, path];
}
else
{
status = [NSString stringWithFormat:
@"Moved %@ to %@", from, path];
}
}
else
{
status = [NSString stringWithFormat:
@"Unable to archive log %@ into %@", name, sub];
}
/*
* Check for pre-existing file - if found, try another.
*/
base = path;
path = [base stringByAppendingPathExtension: @"0"];
gzpath = [path stringByAppendingPathExtension: @"gz"];
while ([mgr fileExistsAtPath: path] == YES
|| [mgr fileExistsAtPath: gzpath] == YES)
{
NSString *ext;
ext = [stringClass stringWithFormat: @"%u", ++count];
path = [base stringByAppendingPathExtension: ext];
gzpath = [path stringByAppendingPathExtension: @"gz"];
}
if ([mgr movePath: from
toPath: path
handler: nil] == NO)
{
status = [NSString stringWithFormat:
@"Unable to move %@ to %@", from, path];
}
else
{
status = [NSString stringWithFormat:
@"Moved %@ to %@", from, path];
}
}
else
{
status = [NSString stringWithFormat:
@"Unable to archive log %@ into %@", name, sub];
}
}
}
}
NS_HANDLER
{
status = [NSString stringWithFormat: @"Problem in %@ with %@ to %@ - %@",
NSStringFromSelector(_cmd), name, sub, localException];
NSStringFromSelector(_cmd), name, when, localException];
}
NS_ENDHANDLER
return status;