From c613a3b701e9aee50545a201335cd0fe0851f9bf Mon Sep 17 00:00:00 2001
From: Frederic Massart <fred@moodle.com>
Date: Wed, 9 Apr 2014 20:25:46 +0800
Subject: [PATCH] Config command has an option to edit the config file

---
 config-dist.json       |  2 ++
 lib/commands/config.py | 35 +++++++++++++++++++++++++++++++++++
 lib/commands/doctor.py |  2 +-
 lib/config.py          | 13 ++++++++++++-
 lib/exceptions.py      | 12 ------------
 lib/tools.py           | 19 ++++++++++++++++++-
 6 files changed, 68 insertions(+), 15 deletions(-)

diff --git a/config-dist.json b/config-dist.json
index 65e9a01..f2bdc64 100644
--- a/config-dist.json
+++ b/config-dist.json
@@ -171,6 +171,8 @@
     "recess": "/usr/local/bin/recess",
     // Path to lessc
     "lessc": "/usr/local/bin/lessc",
+    // Path to your favourite editor
+    "editor": "/usr/bin/vim",
 
     // Debug level of MDK. 'debug', 'info', 'warning', 'error' or 'critical'.
     "debug": "info",
diff --git a/lib/commands/config.py b/lib/commands/config.py
index 054aebf..c37cb43 100644
--- a/lib/commands/config.py
+++ b/lib/commands/config.py
@@ -22,7 +22,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 http://github.com/FMCorz/mdk
 """
 
+import logging
 from lib.command import Command
+from lib.tools import launchEditor, yesOrNo
+from lib.config import ConfigObject, ConfigFileCouldNotBeLoaded
 
 
 class ConfigCommand(Command):
@@ -34,6 +37,12 @@ class ConfigCommand(Command):
                 'help': 'the action to perform',
                 'metavar': 'action',
                 'sub-commands': {
+                    'edit': (
+                        {
+                            'help': 'opens the config file in an editor'
+                        },
+                        []
+                    ),
                     'flatlist': (
                         {
                             'help': 'flat list of the settings'
@@ -110,6 +119,32 @@ class ConfigCommand(Command):
         if args.action == 'list':
             self.dictDisplay(self.C.get(), 0)
 
+        elif args.action == 'edit':
+            f = self.C.userFile
+            success = None
+
+            while True:
+                tmpfile = launchEditor(filepath=f, suffix='.json')
+                co = ConfigObject()
+                try:
+                    co.loadFromFile(tmpfile)
+                except ConfigFileCouldNotBeLoaded:
+                    success = False
+                    logging.error('I could not load the file, you probably screwed up the JSON...')
+                    if yesOrNo('Would you like to continue editing? If not the changes will be discarded.'):
+                        f = tmpfile
+                        continue
+                    else:
+                        break
+                else:
+                    success = True
+                    break
+
+            if success:
+                with open(tmpfile, 'r') as new:
+                    with open(self.C.userFile, 'w') as current:
+                        current.write(new.read())
+
         elif args.action == 'flatlist':
             self.flatDisplay(self.C.get())
 
diff --git a/lib/commands/doctor.py b/lib/commands/doctor.py
index 2ffda9c..42b0b79 100644
--- a/lib/commands/doctor.py
+++ b/lib/commands/doctor.py
@@ -214,7 +214,7 @@ class DoctorCommand(Command):
         print 'Checking dependencies'
 
         hasErrors = False
-        for k in ['git', 'php', 'java', 'recess', 'lessc']:
+        for k in ['git', 'php', 'java', 'recess', 'lessc', 'editor']:
             path = self.C.get(k)
             if not path or not os.path.isfile(path):
                 print '  The path to \'%s\' is invalid: %s' % (k, path)
diff --git a/lib/config.py b/lib/config.py
index 1836096..4c8032a 100644
--- a/lib/config.py
+++ b/lib/config.py
@@ -26,7 +26,6 @@ import os
 import json
 import re
 import copy
-from exceptions import ConfigFileCouldNotBeLoaded, ConfigFileNotFound, ConfigFileCouldNotBeSaved
 
 
 class ConfigObject(object):
@@ -289,3 +288,15 @@ class Conf(Config):
         """Set a new setting"""
         super(Conf, self).set(name, value)
         self.save()
+
+
+class ConfigFileNotFound(Exception):
+    pass
+
+
+class ConfigFileCouldNotBeLoaded(Exception):
+    pass
+
+
+class ConfigFileCouldNotBeSaved(Exception):
+    pass
diff --git a/lib/exceptions.py b/lib/exceptions.py
index 91cdeaa..f0e7ddb 100644
--- a/lib/exceptions.py
+++ b/lib/exceptions.py
@@ -35,18 +35,6 @@ class BackupDBEngineNotSupported(Exception):
     pass
 
 
-class ConfigFileNotFound(Exception):
-    pass
-
-
-class ConfigFileCouldNotBeLoaded(Exception):
-    pass
-
-
-class ConfigFileCouldNotBeSaved(Exception):
-    pass
-
-
 class ConflictInScriptName(Exception):
     pass
 
diff --git a/lib/tools.py b/lib/tools.py
index 264cba3..523e4fb 100644
--- a/lib/tools.py
+++ b/lib/tools.py
@@ -32,7 +32,10 @@ import threading
 import getpass
 import logging
 import hashlib
+import tempfile
+from lib.config import Conf
 
+C = Conf()
 
 def yesOrNo(q):
     while True:
@@ -85,7 +88,6 @@ def getMDLFromCommitMessage(message):
 def get_current_user():
     """Attempt to get the currently logged in user"""
     username = 'root'
-    import os
     try:
         username = os.getlogin()
     except OSError:
@@ -97,6 +99,21 @@ def get_current_user():
     return username
 
 
+def launchEditor(filepath=None, suffix='.tmp'):
+    """Launchs up an editor
+
+    If filepath is passed, the content of the file is used to populate the editor.
+
+    This returns the path to the saved file.
+    """
+    with tempfile.NamedTemporaryFile(suffix=suffix, delete=False) as tmpfile:
+        with open(filepath, 'r') as f:
+            tmpfile.write(f.read())
+            tmpfile.flush()
+        subprocess.call([C.get('editor'), tmpfile.name])
+    return tmpfile.name
+
+
 def md5file(filepath):
     """Return the md5 sum of a file
     This is terribly memory inefficient!"""
-- 
2.11.0