novelWriter/nw/project/document.py

# -*- coding: utf-8 -*-
"""novelWriter Project Document

 novelWriter – Project Document
================================
 Class holding a document

 File History:
 Created: 2018-09-29 [0.0.1]

 This file is a part of novelWriter
 Copyright 2020, Veronica Berglyd Olsen

 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 <https://www.gnu.org/licenses/>.
"""

import logging
import nw

from os import path, mkdir, rename, unlink

from nw.constants import nwAlert

logger = logging.getLogger(__name__)

class NWDoc():

    FILE_MN = "main.nwd"

    def __init__(self, theProject, theParent):

        self.mainConf    = nw.CONFIG
        self.theProject  = theProject
        self.theParent   = theParent
        self.theItem     = None
        self.docHandle   = None
        self.docEditable = False
        self.fileLoc     = None

        # Internal Mapping
        self.makeAlert = self.theParent.makeAlert

        return

    def clearDocument(self):
        self.theItem     = None
        self.docHandle   = None
        self.docEditable = False
        return

    def openDocument(self, tHandle, showStatus=True):

        self.docHandle = tHandle
        self.theItem   = self.theProject.getItem(tHandle)

        if self.theItem is None:
            self.clearDocument()
            return None

        # By default, the document is editable.
        # Except for files in the trash folder.
        self.docEditable = True
        if self.theItem.parHandle == self.theProject.trashRoot:
            self.docEditable = False

        docDir, docFile = self.assemblePath(self.docHandle, self.FILE_MN)
        self.fileLoc = path.join(docDir,docFile)
        logger.debug("Opening document %s" % self.fileLoc)
        dataDir = path.join(self.theProject.projPath, docDir)
        docPath = path.join(dataDir, docFile)

        if path.isfile(docPath):
            try:
                with open(docPath,mode="r",encoding="utf8") as inFile:
                    theDoc = inFile.read()
            except Exception as e:
                self.makeAlert(["Failed to open document file.",str(e)], nwAlert.ERROR)
                # Note: Document must be cleared in case of an io error,
                # or else the auto-save or save will try to overwrite it
                # with an empty file. Return None to alert the caller.
                self.clearDocument()
                return None
        else:
            # The document file does not exist, so we assume it's a new
            # document and initialise an empty text string.
            logger.debug("The requested document does not exist.")
            return ""

        if showStatus:
            self.theParent.statusBar.setStatus("Opened Document: %s" % self.theItem.itemName)

        return theDoc

    def saveDocument(self, docText):

        if self.docHandle is None or not self.docEditable:
            return False

        docDir, docFile = self.assemblePath(self.docHandle, self.FILE_MN)
        logger.debug("Saving document %s" % path.join(docDir,docFile))
        dataPath = path.join(self.theProject.projPath, docDir)
        docPath  = path.join(dataPath, docFile)
        if not path.isdir(dataPath):
            mkdir(dataPath)
            logger.debug("Created folder %s" % dataPath)

        docTemp = path.join(dataPath, docFile+"~")
        docBack = path.join(dataPath, docFile[:-3]+"bak")

        try:
            with open(docTemp,mode="w",encoding="utf8") as outFile:
                outFile.write(docText)
        except Exception as e:
            self.makeAlert(["Could not save document.",str(e)], nwAlert.ERROR)
            return False

        # If we're here, the file was successfully saved,
        # so let's sort out the temps and backups
        if path.isfile(docBack):
            unlink(docBack)
        if path.isfile(docPath):
            rename(docPath, docBack)
        rename(docTemp, docPath)

        self.theParent.statusBar.setStatus("Saved Document: %s" % self.theItem.itemName)

        return True

    def deleteDocument(self, tHandle):
        """Permanently delete a document source file and its backups
        from the project data folder.
        """
        docDir, docFile = self.assemblePath(tHandle, self.FILE_MN)
        dataPath = path.join(self.theProject.projPath, docDir)
        chkList = []
        chkList.append(path.join(dataPath, docFile))
        chkList.append(path.join(dataPath, docFile+"~"))
        chkList.append(path.join(dataPath, docFile[:-3]+"bak"))
        for chkFile in chkList:
            if path.isfile(chkFile):
                try:
                    unlink(chkFile)
                    logger.debug("Deleted: %s" % chkFile)
                except Exception as e:
                    self.makeAlert(["Could not delete document file.",str(e)], nwAlert.ERROR)
                    return False
        return True

    @staticmethod
    def assemblePath(tHandle, docExt):
        if tHandle is None:
            return None, None
        docDir  = "data_"+tHandle[0]
        docFile = tHandle[1:13]+"_"+docExt
        return docDir, docFile

# END Class NWDoc