source: trunk/PrefsPane/src/ProxyScriptEditor.m @ 1046

/* Copyright (C) 2008-2009 Peter Speck
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#import "ProxyScriptEditor.h"
#import "GBDebug.h"
#import "ClickActionTextField.h"
#import "ServerCommunication.h"
#import "Xml.h"
#import "Prefs.h"
#import "NamedEnum.h"
#import "AlertHelper.h"

NamedEnum* proxyTypeEnum;

@interface ProxyScriptEditor ()

- (BOOL)isJavascriptTextStorage:(NSTextStorage*)storage;

- (BOOL)validateSyntax;

- (void)startTimerWithImmediateExecute:(BOOL)immediate;
- (void)stopTimer;
- (void)timerCallback:(NSTimer*)theTimer;

- (void)updateNetworkCodeView;

@end

@implementation ProxyScriptEditor

+ (void)initProxyScriptEditor
{
    if (proxyTypeEnum)
        return;
    proxyTypeEnum = [[NamedEnum alloc] initWithSemicolonList:@"+none;javascript;static"];
}

- (id)initWithServerCommunication:(ServerCommunication*)comm
                       withBundle:(NSBundle*)bundle
                     withDelegate:(id<ProxyScriptEditorDelegate>)delegate
{
    if (!(self = [super init]))
        return nil;
    NSAssert([NSBundle loadNibNamed: @"ProxyScriptEdit" owner: self],
             @"Can't load nib 'ProxyScriptEdit'");
    NSAssert(scriptSheet, @"scriptSheet is null");
    //
    _bundle = [bundle retain];
    _delegate = delegate;
    _comm = [comm retain];
    _prefs = [[_comm prefs] retain];
    _alertHelper = [[_prefs alertHelper] retain];
    _codeEditHelper = [[CodeEditHelper alloc] initWithDelegate:self];
    //
    [tabView selectFirstTabViewItem:self];
    [tabView setDelegate:self];
    [scriptHelpTextLink setTarget:self selector:@selector(scriptHelpAction:)];
    _helpMessage = [[scriptMessageField stringValue] retain];
    [networkCodeView setEditable:NO];
    //
    [_codeEditHelper setCodeTextView:scriptCodeView
                            withText:[_prefs stringForXPath:@"network-settings/proxy-script"]];
    [scriptCodeView setDelegate:self];
    [[scriptCodeView layoutManager] setAllowsNonContiguousLayout:YES];
    [[scriptCodeView textStorage] setDelegate:self];
    [_codeEditHelper syntaxHighlight:[scriptCodeView textStorage] isJavascript:YES];
    //
    NSXMLElement* scriptE = (NSXMLElement*)[_prefs nodeForXPath:@"network-settings/proxy-script"];
    _oldSettingsData = scriptE ? [[Xml subtreeToData:scriptE] retain] : NULL;
    //
    [scriptSheet setFrameUsingName:@"ProxyScriptEditSheet"];
    [self retain]; // until sheet is dismissed.
    [NSApp beginSheet: scriptSheet
       modalForWindow: [_alertHelper window]
        modalDelegate: nil
       didEndSelector: nil
          contextInfo: nil];
    [self startTimerWithImmediateExecute:YES];
    return self;
}

- (void)dealloc
{
    [self stopTimer];
    [_alertHelper release];
    [_prefs release];
    [_comm release];
    [_codeEditHelper release];
    [_oldSettingsData release];
    [_helpMessage release];
    [_bundle release];
    [scriptSheet release];
    [super dealloc];
}

- (BOOL)isJavascriptTextStorage:(NSTextStorage*)storage
{
    return YES;
}

- (void)textStorageDidProcessEditing:(NSNotification *)noti
{
    [_codeEditHelper textStorageDidProcessEditing:noti];
    [self startTimerWithImmediateExecute:NO];
}

//====================================================================================

- (void)updateNetworkCodeView
{
    NSTask* task = [[NSTask alloc] init];
    NSPipe *readPipe = NULL;
    NSFileHandle *readHandle = NULL;
    NSMutableData* outputData = [[NSMutableData dataWithCapacity:0] retain];
    NSAssert(_bundle, @"_bundle");
    NSLog(@"bundle path: %@", [_bundle bundlePath]);
    @try {
        NSString *path = [NSString stringWithFormat:@"%@%@%@",
                          [_bundle bundlePath],
                          @"/Contents/GlimmerBlockerProxy.app",
                          @"/Contents/MacOS/GBNetworkConfigurationListener"];
        NSLog(@"NHT: %@", path);
        [task setLaunchPath:path];
        [task setCurrentDirectoryPath:@"/tmp"];
        readPipe = [[NSPipe pipe] retain];
        readHandle = [[readPipe fileHandleForReading] retain];
        [task setStandardOutput:readPipe];
        [task launch];
        while (1) {
            NSData* data = [readHandle availableData];
            if (!data || ![data length])
                break;
            [outputData appendData:data];
        }
        [task waitUntilExit];
        //DebugNSLog(@"task retains: %d", [task retainCount]);
    }
    @catch (NSException* ex) {
        NSLog(@"GBNetworkConfigurationListener failed with exception: %@", [ex name]);
        [GBDebug debugDumpStackframe];
    }
    if ([task isRunning])
        [task terminate];
    [task release];
    [readHandle release];
    [readPipe release];
    NSString* json = [[NSString alloc] initWithData:outputData encoding:NSUTF8StringEncoding];
    [outputData release];
    if ([json isEqual:[networkCodeView string]])
        return; // no need to spend time reformatting code.
    [networkCodeView setString:json];
    [_codeEditHelper syntaxHighlight:[networkCodeView textStorage] isJavascript:YES];
}

//====================================================================================

- (void)startTimerWithImmediateExecute:(BOOL)immediate
{
    [self stopTimer];
    _timer = [[NSTimer scheduledTimerWithTimeInterval:(immediate ? 0.1 : 1.2)
                                               target:self
                                             selector:@selector(timerCallback:)
                                             userInfo:NULL
                                              repeats:NO] retain];
}

- (void)stopTimer
{
    if (!_timer)
        return;
    [_timer invalidate];
    [_timer release];
    _timer = NULL;
}

- (void)timerCallback:(NSTimer*)theTimer
{
    [self validateSyntax];
}

//====================================================================================

- (BOOL)textView:(NSTextView*)aTextView doCommandBySelector:(SEL)aSelector
{
#ifdef DEBUG_DCBS
    DebugNSLog(@"doCommandBySelector: %s", aSelector);
#endif
    BOOL newlineSelector = (aSelector == @selector(insertNewline:));
    // I can't find noop: anywhere, so I don't know what the expected return type is.
    BOOL noopSelector = [NSStringFromSelector(aSelector) isEqual:@"noop:"];
    if (!newlineSelector && !noopSelector)
        return NO; // No, I did not handle it.
    NSEvent* event = [NSApp currentEvent];
    if ([event type] != NSKeyDown || [event isARepeat])
        return NO; // No, I did not handle it.
#ifdef DEBUG_DCBS
    DebugNSLog(@" current keydown event: %@", [NSApp currentEvent]);
#endif
    NSUInteger modifiers = [event modifierFlags] & NSDeviceIndependentModifierFlagsMask;
    NSString* s = [event charactersIgnoringModifiers];
    BOOL enter = newlineSelector && !modifiers && [s length] == 1 && [s characterAtIndex:0] == 3;
    BOOL appleReturn = noopSelector && (modifiers == NSCommandKeyMask) && [s length] == 1 && [s characterAtIndex:0] == 13;
#ifdef DEBUG_DCBS
    DebugNSLog(@"KeyDown(%d = %x) for %d, enter = %d, appleReturn = %d", modifiers, modifiers, [s characterAtIndex:0], enter, appleReturn);
#endif
    if (!enter && !appleReturn)
        return NO; // No, I did not handle it.
#ifdef DEBUG_DCBS
    DebugNSLog(@"KeyDown executes self.commitAction:");
#endif
    [saveBtn highlight:YES];
    [self performSelectorOnMainThread:@selector(commitAction:)
                           withObject:self
                        waitUntilDone:NO];
    return YES; // Yes, I did handle it.
}

//====================================================================================

- (IBAction)scriptHelpAction:(id)sender
{
    NSURL* url = [NSURL URLWithString:@"http://glimmerblocker.org/wiki/Proxies"];
    [[NSWorkspace sharedWorkspace] openURL:url];
}

- (void)dismissSheet
{
    [scriptSheet saveFrameUsingName:@"ProxyScriptEditSheet"];
    [NSApp endSheet:scriptSheet];
    [scriptSheet orderOut:self];
}

- (IBAction)cancelAction:(id)sender
{
    [self stopTimer];
    [self dismissSheet];
    [self autorelease];
}

- (BOOL)validateSyntax
{
    NSString* js = [_codeEditHelper trimmedTextViewString:scriptCodeView];
    NSString* pathArgs = [NSString stringWithFormat:@"/site-proxy/validate?javascript=%@",
                          [GBDebug percentEscapeUrlParameterValue:js]];
    XmlDoc* doc = [_comm curlToXml:pathArgs withActionDescription:NULL];
    if (!doc) {
        DebugNSLog(@"Problem validating JS.");
        return YES; // don't stop the user saving it, if the proxy failed running.
    }
    NSString* msg = [doc stringForXPath:@"@proxy-error"];
    if ([msg length]) {
        [scriptMessageField setStringValue:msg];
        [scriptMessageField setTextColor:[NSColor redColor]];
        return NO;
    } else {
        [scriptMessageField setStringValue:_helpMessage];
        [scriptMessageField setTextColor:[NSColor blackColor]];
        return YES;
    }
}

- (void)saveSettingsInElement:(NSXMLElement*)scriptE
{
    NSString* js = [_codeEditHelper trimmedTextViewString:scriptCodeView];
    //DebugNSLog(@"Script: {{{%@}}}", js);
    if (![js length])
        return;
    [Xml setCData:js forXPath:@"." withRoot:scriptE];
    [Xml setAttribute:@"js" withName:@"language" inElement:scriptE];
    [Xml setAttribute:@"1" withName:@"version" inElement:scriptE];
}

- (BOOL)isDirty
{
    NSXMLElement* scriptE = [Xml createElementWithName:@"proxy-script"];
    [self saveSettingsInElement:scriptE];
    NSData* data = [Xml subtreeToData:scriptE];
    return ![data isEqualToData:_oldSettingsData];
}

- (IBAction)commitAction:(id)sender
{
    [self stopTimer];
    BOOL dirty = [self isDirty];
    if (dirty) {
        NSXMLElement* scriptE = [_prefs singletonElementForXPath:@"network-settings/proxy-script"];
        [self saveSettingsInElement:scriptE];
        [_prefs markAsDirty];
        [_comm saveDirtyPrefsAndNotify];
    }
    [self dismissSheet];
    [_delegate notifyProxyScriptEditorCommitted:self];
    [self autorelease];
}

@end

@implementation ProxyScriptEditor(NSTabViewDelegate)

- (void)tabView:(NSTabView *)tabView didSelectTabViewItem:(NSTabViewItem *)tabViewItem
{
    if ([[tabViewItem identifier] isEqual:@"network"])
        [self updateNetworkCodeView];
}

@end