Merge pull request #406 from fcollonval/plaintextdiff-cm

Plain text diff

Author: fcollonval

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -109,3 +110,4 @@ MANIFEST
 jupyterlab_git/labextension/*.tgz
 .pytest_cache/
 *.tsbuildinfo
+.pytest_cache/

jupyterlab_git/__init__.py

@@ -12,17 +12,10 @@ def _jupyter_server_extension_paths():
     return [{"module": "jupyterlab_git"}]
 
 
-def _jupyter_nbextension_paths():
-    """
-    Declare the Jupyter notebook extension paths.
-    """
-    return [{"section": "notebook", "dest": "jupyterlab_git"}]
-
-
 def load_jupyter_server_extension(nbapp):
     """
     Load the Jupyter server extension.
     """
-    git = Git(nbapp.web_app.settings.get('server_root_dir'))
+    git = Git(nbapp.web_app.settings['contents_manager'])
     nbapp.web_app.settings["git"] = git
     setup_handlers(nbapp.web_app)

jupyterlab_git/git.py

@@ -24,6 +24,7 @@ def __init__(self, command, cwd, env, username, password):
         self.env = env
         self.username = username
         self.password = password
+
     def communicate(self):
         try:
             p = pexpect.spawn(
@@ -64,8 +65,9 @@ class Git:
     A single parent class containing all of the individual git methods in it.
     """
 
-    def __init__(self, root_dir):
-        self.root_dir = os.path.expanduser(root_dir)
+    def __init__(self, contents_manager):
+        self.contents_manager = contents_manager
+        self.root_dir = os.path.realpath(os.path.expanduser(contents_manager.root_dir))
 
     def config(self, top_repo_path, **kwargs):
         """Get or set Git options.
@@ -892,3 +894,55 @@ def _get_tag(self, current_path, commit_sha):
                     error.decode("utf-8"), " ".join(command)
                 )
             )
+
+    def show(self, filename, ref, top_repo_path):
+        """
+        Execute git show <ref:filename> command & return the result.
+        """
+        command = ["git", "show", '{}:{}'.format(ref, filename)]
+        p = subprocess.Popen(
+            command,
+            stdout=PIPE,
+            stderr=PIPE,
+            cwd=top_repo_path
+        )
+        output, error = p.communicate()
+
+        error_messages = map(lambda n: n.lower(), [
+            "fatal: Path '{}' exists on disk, but not in '{}'".format(filename, ref),
+            "fatal: Path '{}' does not exist (neither on disk nor in the index)".format(filename)
+        ])
+        lower_error = error.decode('utf-8').lower()
+        if p.returncode == 0:
+            return output.decode('utf-8')
+        elif any([msg in lower_error for msg in error_messages]):
+            return ""
+        else:
+            raise HTTPError(log_message='Error [{}] occurred while executing [{}] command to retrieve plaintext diff.'.format(
+                error.decode('utf-8'),
+                ' '.join(command)
+            ))
+
+    def get_content(self, filename, top_repo_path):
+        """
+        Get the file content of filename.
+        """
+        relative_repo = os.path.relpath(top_repo_path, self.root_dir)
+        model = self.contents_manager.get(path=os.path.join(relative_repo, filename))
+        return model['content']
+
+    def diff_content(self, filename, prev_ref, curr_ref, top_repo_path):
+        """
+        Collect get content of prev and curr and return.
+        """
+        prev_content = self.show(filename, prev_ref["git"], top_repo_path)
+        if "special" in curr_ref:
+            if curr_ref["special"] == "WORKING":
+                curr_content = self.get_content(filename, top_repo_path)
+            elif curr_ref["special"] == "INDEX":
+                curr_content = self.show(filename, "", top_repo_path)
+            else:
+                raise HTTPError(log_message="Error while retrieving plaintext diff, unknown special ref '{}'.".format(curr_ref["special"]))
+        else:
+            curr_content = self.show(filename, curr_ref["git"], top_repo_path)
+        return {"prev_content": prev_content, "curr_content": curr_content}

jupyterlab_git/handlers.py

@@ -2,8 +2,9 @@
 Module with all the individual handlers, which execute git commands and return the results to the frontend.
 """
 import json
+import os
 
-from notebook.utils import url_path_join as ujoin
+from notebook.utils import url_path_join as ujoin, url2path
 from notebook.base.handlers import APIHandler
 
 
@@ -470,6 +471,22 @@ def post(self):
             self.set_status(201)
         self.finish(json.dumps(response))
 
+class GitDiffContentHandler(GitHandler):
+    """
+    Handler for plain text diffs. Uses git show $REF:$FILE
+    Returns `prev_content` and `curr_content` with content of given file.
+    """
+
+    def post(self):
+        cm = self.contents_manager
+        data = self.get_json_body()
+        filename = data["filename"]
+        prev_ref = data["prev_ref"]
+        curr_ref = data["curr_ref"]
+        top_repo_path = os.path.join(cm.root_dir, url2path(data["top_repo_path"]))
+        response = self.git.diff_content(filename, prev_ref, curr_ref, top_repo_path)
+        self.finish(json.dumps(response))
+
 
 class GitServerRootHandler(GitHandler):
 
@@ -509,7 +526,8 @@ def setup_handlers(web_app):
         ("/git/upstream", GitUpstreamHandler),
         ("/git/config", GitConfigHandler),
         ("/git/changed_files", GitChangedFilesHandler),
-        ("/git/server_root", GitServerRootHandler)
+        ("/git/server_root", GitServerRootHandler),
+        ("/git/diffcontent", GitDiffContentHandler)
     ]
 
     # add the baseurl to our paths