diff options
| -rw-r--r-- | core/views/expo.py | 50 | ||||
| -rw-r--r-- | lib/version_control.py | 46 |
2 files changed, 50 insertions, 46 deletions
diff --git a/core/views/expo.py b/core/views/expo.py index 6256aab..d2a5d88 100644 --- a/core/views/expo.py +++ b/core/views/expo.py @@ -1,6 +1,5 @@ import os import re -import subprocess from sys import getfilesystemencoding as sys_getfilesystemencoding @@ -22,6 +21,8 @@ from troggle.core.models.caves import Cave import troggle.core.views.caves import troggle.settings as settings +from troggle.lib import version_control + '''Formerly a separate package called 'flatpages' written by Martin Green 2011. This was NOT django.contrib.flatpages which stores HTML in the database, so the name was changed to expopages. @@ -341,8 +342,8 @@ def editexpopage(request, path): if result != html: # Check if content changed try: - write_and_commit(filepath, result) - except WriteAndCommitError as e: + version_control.write_and_commit(filepath, result) + except version_control.WriteAndCommitError as e: return render(request,'errors/generic.html', {'message': e.message}) return HttpResponseRedirect(reverse('expopage', args=[path])) # Redirect after POST @@ -365,49 +366,6 @@ def editexpopage(request, path): pageform = ExpoPageForm({"html": body, "title": "Missing"}) return render(request, 'editexpopage.html', {'path': path, 'form': pageform, }) -class WriteAndCommitError(Exception): - - def __init__(self, message): - self.message = message - - def __str__(self): - return f'WriteAndCommitError: {self.message}' - -def write_and_commit(filepath, content): - cwd = filepath.parent - filename = filepath.name - git = settings.GIT - # GIT see also core/models/caves.py writetrogglefile() - # GIT see also core/views/uploads.py dwgupload() - - try: - with open(filepath, "w", encoding="utf8") as f: - print(f'WRITING{cwd}---{filename} ') - # as the wsgi process www-data, we have group write-access but are not owner, so cannot chmod. - # os.chmod(filepath, 0o664) # set file permissions to rw-rw-r-- - f.write(content) - except PermissionError: - message = f'CANNOT save this file.\nPERMISSIONS incorrectly set on server for this file {filename}. Ask a nerd to fix this.' - raise WriteAndCommitError(message) - - try: - cp_add = subprocess.run([git, "add", filename], cwd=cwd, capture_output=True, text=True) - if cp_add.returncode != 0: - msgdata = 'Ask a nerd to fix this.\n\n' + cp_add.stderr + '\n\n' + cp_add.stdout + '\n\nreturn code: ' + str(cp_add.returncode) - message = f'CANNOT git on server for this file {filename}. Edits saved but not added to git.\n\n' + msgdata - raise WriteAndCommitError(message) - - cp_commit = subprocess.run([git, "commit", "-m", f'Troggle online: Edit this page - {filename}'], cwd=cwd, capture_output=True, text=True) - # This produces return code = 1 if it commits OK, but when the repo still needs to be pushed to origin/expoweb - if cp_commit.returncode != 0 and cp_commit.stdout != 'nothing to commit, working tree clean': - msgdata = 'Ask a nerd to fix this.\n\n' + cp_commit.stderr + '\n\n' + cp_commit.stdout + '\n\nreturn code: ' + str(cp_commit.returncode) - message = f'Error code with git on server for this file {filename}. Edits saved, added to git, but NOT committed.\n\n' + msgdata - raise WriteAndCommitError(message) - - except subprocess.SubprocessError: - message = f'CANNOT git on server for this file {filename}. Subprocess error. Edits not saved.\nAsk a nerd to fix this.' - raise WriteAndCommitError(message) - class ExpoPageForm(forms.Form): '''The form used by the editexpopage function ''' diff --git a/lib/version_control.py b/lib/version_control.py new file mode 100644 index 0000000..08e6172 --- /dev/null +++ b/lib/version_control.py @@ -0,0 +1,46 @@ +import troggle.settings as settings +import subprocess + +def write_and_commit(filepath, content): + """Writes the content to the filepath and adds and commits the file to git. If this fails, a WriteAndCommitError is raised.""" + cwd = filepath.parent + filename = filepath.name + git = settings.GIT + # GIT see also core/models/cave.py writetrogglefile() + # GIT see also core/views/uploads.py dwgupload() + + try: + with open(filepath, "w", encoding="utf8") as f: + print(f'WRITING{cwd}---{filename} ') + # as the wsgi process www-data, we have group write-access but are not owner, so cannot chmod. + # os.chmod(filepath, 0o664) # set file permissions to rw-rw-r-- + f.write(content) + except PermissionError: + message = f'CANNOT save this file.\nPERMISSIONS incorrectly set on server for this file {filename}. Ask a nerd to fix this.' + raise WriteAndCommitError(message) + + try: + cp_add = subprocess.run([git, "add", filename], cwd=cwd, capture_output=True, text=True) + if cp_add.returncode != 0: + msgdata = 'Ask a nerd to fix this.\n\n' + cp_add.stderr + '\n\n' + cp_add.stdout + '\n\nreturn code: ' + str(cp_add.returncode) + message = f'CANNOT git on server for this file {filename}. Edits saved but not added to git.\n\n' + msgdata + raise WriteAndCommitError(message) + + cp_commit = subprocess.run([git, "commit", "-m", f'Troggle online: Edit this page - {filename}'], cwd=cwd, capture_output=True, text=True) + # This produces return code = 1 if it commits OK, but when the repo still needs to be pushed to origin/expoweb + if cp_commit.returncode != 0 and cp_commit.stdout != 'nothing to commit, working tree clean': + msgdata = 'Ask a nerd to fix this.\n\n' + cp_commit.stderr + '\n\n' + cp_commit.stdout + '\n\nreturn code: ' + str(cp_commit.returncode) + message = f'Error code with git on server for this file {filename}. Edits saved, added to git, but NOT committed.\n\n' + msgdata + raise WriteAndCommitError(message) + + except subprocess.SubprocessError: + message = f'CANNOT git on server for this file {filename}. Subprocess error. Edits not saved.\nAsk a nerd to fix this.' + raise WriteAndCommitError(message) + +class WriteAndCommitError(Exception): + """Exception class for errors writing files and comitting them to git""" + def __init__(self, message): + self.message = message + + def __str__(self): + return f'WriteAndCommitError: {self.message}' |