photobash_images_docker.py

Go to the documentation of this file.

# Photobash Images is a Krita plugin to get CC0 images based on a search,
# straight from the Krita Interface. Useful for textures and concept art!
# Copyright (C) 2020  Pedro Reis.
#
# 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/>.
 
 
from krita import Krita, DockWidget, FileDialog
from builtins import Application, i18n, i18nc
import copy
import math
try:
    from PyQt6 import uic
    from PyQt6.QtCore import Qt, QDirIterator, QMimeData, QUrl, QStandardPaths
    from PyQt6.QtWidgets import QWidget, QSizePolicy, QApplication, QMessageBox
    from PyQt6.QtGui import QImage
except:
    from PyQt5 import uic
    from PyQt5.QtCore import Qt, QDirIterator, QMimeData, QUrl, QStandardPaths
    from PyQt5.QtWidgets import QWidget, QSizePolicy, QApplication, QMessageBox
    from PyQt5.QtGui import QImage
from .photobash_images_modulo import (
    Photobash_Display,
    Photobash_Button,
)
import os.path
 
class PhotobashDocker(DockWidget):
    def __init__(self):
        super().__init__()
 
        # Construct
        self.setupVariables()
        self.setupInterface()
        self.setupModules()
        self.setStyle()
        self.initialize()
 
    def setupVariables(self):
        self.mainWidget = QWidget(self)
 
        self.applicationName = "Photobash"
        self.referencesSetting = "referencesDirectory"
        self.fitCanvasSetting = "fitToCanvas"
        self.foundFavouritesSetting = "currentFavourites"
 
        self.currImageScale = 100
        self.fitCanvasChecked = bool(Application.readSetting(self.applicationName, self.fitCanvasSetting, "True"))
        self.imagesButtons = []
        self.foundImages = []
        self.favouriteImages = []
        # maps path to image
        self.cachedImages = {}
        # store order of push
        self.cachedPathImages = []
        self.maxCachedImages = 90
        self.maxNumPages = 9999
 
        self.currPage = 0
        self.directoryPath = Application.readSetting(self.applicationName, self.referencesSetting, "")
        favouriteImagesValues = Application.readSetting(self.applicationName, self.foundFavouritesSetting, "").split("'")
 
        for value in favouriteImagesValues:
            if value != "[" and value != ", " and value != "]" and value != "" and value != "[]":
                self.favouriteImages.append(value)
 
        self.bg_alpha = str("background-color: rgba(0, 0, 0, 50); ")
        self.bg_hover = str("background-color: rgba(0, 0, 0, 100); ")
 
    def setupInterface(self):
        # Window
        self.setWindowTitle(i18nc("@title:window", "Photobash Images"))
 
        # Path Name
        self.directoryPlugin = str(os.path.dirname(os.path.realpath(__file__)))
 
        # Photo Bash Docker
        self.mainWidget = QWidget(self)
        self.setWidget(self.mainWidget)
 
        self.layout = uic.loadUi(self.directoryPlugin + '/photobash_images_docker.ui', self.mainWidget)
 
        self.layoutButtons = [
            self.layout.imagesButtons0,
            self.layout.imagesButtons1,
            self.layout.imagesButtons2,
            self.layout.imagesButtons3,
            self.layout.imagesButtons4,
            self.layout.imagesButtons5,
            self.layout.imagesButtons6,
            self.layout.imagesButtons7,
            self.layout.imagesButtons8,
        ]
 
        # Adjust Layouts
        self.layout.imageWidget.setSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Ignored)
        self.layout.middleWidget.setSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Expanding)
 
        # setup connections for top elements
        self.layout.filterTextEdit.textChanged.connect(self.textFilterChangedtextFilterChanged)
        self.layout.changePathButton.clicked.connect(self.changePathchangePath)
        # setup connections for bottom elements
        self.layout.previousButton.clicked.connect(lambda: self.updateCurrentPage(-1))
        self.layout.nextButton.clicked.connect(lambda: self.updateCurrentPage(1))
        self.layout.scaleSlider.valueChanged.connect(self.updateScaleupdateScale)
        self.layout.paginationSlider.setMinimum(0)
        self.layout.paginationSlider.valueChanged.connect(self.updatePageupdatePage)
        self.layout.fitCanvasCheckBox.stateChanged.connect(self.changedFitCanvaschangedFitCanvas)
 
    def setupModules(self):
        # Display Single
        self.imageWidget = Photobash_Display(self.layout.imageWidget)
        self.imageWidget.SIGNAL_HOVER.connect(self.cursorHovercursorHover)
        self.imageWidget.SIGNAL_CLOSE.connect(self.closePreviewclosePreview)
 
        # Display Grid
        self.imagesButtons = []
        for i in range(0, len(self.layoutButtons)):
            layoutButton = self.layoutButtons[i]
            imageButton = Photobash_Button(layoutButton)
            imageButton.setNumber(i)
            imageButton.SIGNAL_HOVER.connect(self.cursorHovercursorHover)
            imageButton.SIGNAL_LMB.connect(self.buttonClickbuttonClick)
            imageButton.SIGNAL_WUP.connect(lambda: self.updateCurrentPage(-1))
            imageButton.SIGNAL_WDN.connect(lambda: self.updateCurrentPage(1))
            imageButton.SIGNAL_PREVIEW.connect(self.openPreviewopenPreview)
            imageButton.SIGNAL_FAVOURITE.connect(self.pinToFavouritespinToFavourites)
            imageButton.SIGNAL_UN_FAVOURITE.connect(self.unpinFromFavouritesunpinFromFavourites)
            imageButton.SIGNAL_OPEN_NEW.connect(self.openNewDocumentopenNewDocument)
            imageButton.SIGNAL_REFERENCE.connect(self.placeReferenceplaceReference)
            self.imagesButtons.append(imageButton)
 
    def setStyle(self):
        # Displays
        self.cursorHovercursorHover(None)
 
    def initialize(self):
        # initialize based on what was setup
        if self.directoryPath != "":
            self.layout.changePathButton.setText(i18n("Change References Folder"))
            self.getImagesFromDirectory()
            self.layout.fitCanvasCheckBox.setChecked(self.fitCanvasChecked)
 
        # initial organization of images with favourites
        self.reorganizeImages()
        self.layout.scaleSliderLabel.setText(i18n("Image Scale: {0}%").format(100))
 
        self.updateImages()
 
    def reorganizeImages(self):
        # organize images, taking into account favourites
        # and their respective order
        favouriteFoundImages = []
        for image in self.favouriteImages:
            if image in self.foundImages:
                self.foundImages.remove(image)
                favouriteFoundImages.append(image)
 
        self.foundImages = favouriteFoundImages + self.foundImages
 
    def textFilterChanged(self):
        stringsInText = self.layout.filterTextEdit.text().lower().split(" ")
        if self.layout.filterTextEdit.text().lower() == "":
            self.foundImages = copy.deepcopy(self.allImages)
            self.reorganizeImages()
            self.updateImages()
            return 
 
        newImages = []
        for word in stringsInText:
            for path in self.allImages:
                # exclude path outside from search
                if word in path.replace(self.directoryPath, "").lower() and not path in newImages and word != "" and word != " ":
                    newImages.append(path)
 
        self.foundImages = newImages
        self.reorganizeImages()
        self.updateImages()
 
    def getImagesFromDirectory(self):
        newImages = []
        self.currPage = 0
 
        if self.directoryPath == "":
            self.foundImages = []
            self.favouriteImages = []
            self.updateImages()
            return 
 
        it = QDirIterator(self.directoryPath, QDirIterator.IteratorFlag.Subdirectories)
 
 
        while(it.hasNext()):
            if (".webp" in it.filePath() or ".png" in it.filePath() or ".jpg" in it.filePath() or ".jpeg" in it.filePath()) and \
                (not ".webp~" in it.filePath() and not ".png~" in it.filePath() and not ".jpg~" in it.filePath() and not ".jpeg~" in it.filePath()):
                newImages.append(it.filePath())
 
            it.next()
 
        self.foundImages = copy.deepcopy(newImages)
        self.allImages = copy.deepcopy(newImages)
        self.reorganizeImages()
        self.updateImages()
 
    def updateCurrentPage(self, increment):
        if (self.currPage == 0 and increment == -1) or \
            ((self.currPage + 1) * len(self.imagesButtons) > len(self.foundImages) and increment == 1) or \
            len(self.foundImages) == 0:
            return
 
        self.currPage += increment
        maxNumPage = math.ceil(len(self.foundImages) / len(self.layoutButtons))
        self.currPage = max(0, min(self.currPage, maxNumPage - 1))
        self.updateImages()
 
    def updateScale(self, value):
        self.currImageScale = value
        self.layout.scaleSliderLabel.setText(i18n("Image Scale: {0}%").format(self.currImageScale))
 
        # update layout buttons, needed when dragging
        self.imageWidget.setImageScale(self.currImageScale)
 
        # normal images
        for i in range(0, len(self.imagesButtons)):
            self.imagesButtons[i].setImageScale(self.currImageScale)
 
    def updatePage(self, value):
        maxNumPage = math.ceil(len(self.foundImages) / len(self.layoutButtons))
        self.currPage = max(0, min(value, maxNumPage - 1))
        self.updateImages()
 
    def changedFitCanvas(self, state):
        if state == Qt.CheckState.Checked:
            self.fitCanvasChecked = True
            Application.writeSetting(self.applicationName, self.fitCanvasSetting, "true")
        else:
            self.fitCanvasChecked = False
            Application.writeSetting(self.applicationName, self.fitCanvasSetting, "false")
 
        # update layout buttons, needed when dragging
        self.imageWidget.setFitCanvas(self.fitCanvasChecked)
 
        # normal images
        for i in range(0, len(self.imagesButtons)):
            self.imagesButtons[i].setFitCanvas(self.fitCanvasChecked)
 
    def cursorHover(self, SIGNAL_HOVER):
        # Display Image
        self.layout.imageWidget.setStyleSheet(self.bg_alpha)
        if SIGNAL_HOVER == "D":
            self.layout.imageWidget.setStyleSheet(self.bg_hover)
 
        # normal images
        for i in range(0, len(self.layoutButtons)):
            self.layoutButtons[i].setStyleSheet(self.bg_alpha)
 
            if SIGNAL_HOVER == str(i):
                self.layoutButtons[i].setStyleSheet(self.bg_hover)
 
    # checks if image is cached, and if it isn't, create it and cache it
    def getImage(self, path):
        if path in self.cachedPathImages:
            return self.cachedImages[path]
 
        # need to remove from cache
        if len(self.cachedImages) > self.maxCachedImages: 
            removedPath = self.cachedPathImages.pop()
            self.cachedImages.pop(removedPath)
 
        self.cachedPathImages = [path] + self.cachedPathImages
        self.cachedImages[path] = QImage(path).scaled(200, 200, Qt.AspectRatioMode.KeepAspectRatio, Qt.TransformationMode.FastTransformation)
 
        return self.cachedImages[path]
 
    # makes sure the first 9 found images exist
    def checkValidImages(self):
        found = 0
        for path in self.foundImages:
            if found == 9:
                return
 
            if self.checkPath(path):
                found = found + 1
 
    def updateImages(self):
        self.checkValidImages()
        buttonsSize = len(self.imagesButtons)
 
        # don't try to access image that isn't there
        maxRange = min(len(self.foundImages) - self.currPage * buttonsSize, buttonsSize)
 
        for i in range(0, len(self.imagesButtons)):
            if i < maxRange:
                # image is within valid range, apply it
                path = self.foundImages[i + buttonsSize * self.currPage]
                self.imagesButtons[i].setFavourite(path in self.favouriteImages)
                self.imagesButtons[i].setImage(path, self.getImage(path))
            else:
                # image is outside the range
                self.imagesButtons[i].setFavourite(False)
                self.imagesButtons[i].setImage("",None)
 
        # update text for pagination
        maxNumPage = math.ceil(len(self.foundImages) / len(self.layoutButtons))
        currPage = self.currPage + 1
 
        if maxNumPage == 0:
            currPage = 0
 
        # normalize string length
        if currPage < 10:
            currPage = "   " + str(currPage)
        elif currPage < 100:
            currPage = "  " + str(currPage)
        elif currPage < 1000:
            currPage = " " + str(currPage)
 
        # currPage is the index, but we want to present it in a user friendly way,
        # so it starts at 1
        self.layout.paginationLabel.setText(i18n("Page: {0}/{1}").format(currPage, maxNumPage))
        # correction since array begins at 0
        self.layout.paginationSlider.setRange(0, maxNumPage - 1)
        self.layout.paginationSlider.setSliderPosition(self.currPage)
 
    def addImageLayer(self, photoPath):
        # file no longer exists, remove from all structures
        if not self.checkPath(photoPath):
            self.updateImages()
            return
        
        # Get the document:
        doc = Krita.instance().activeDocument()
 
        # Saving a non-existent document causes crashes, so lets check for that first.
        if doc is None:
            return 
 
        # Check if there is a valid Canvas to place the Image
        if self.canvas() is None or self.canvas().view() is None:
            return 
 
        scale = self.currImageScale / 100
 
        # Scale Image
        if self.fitCanvasChecked:
            image = QImage(photoPath).scaled(int(doc.width() * scale), int(doc.height() * scale), Qt.AspectRatioMode.KeepAspectRatio, Qt.TransformationMode.SmoothTransformation)
        else:
            image = QImage(photoPath)
            # scale image
            image = image.scaled(int(image.width() * scale), int(image.height() * scale), Qt.AspectRatioMode.KeepAspectRatio, Qt.TransformationMode.SmoothTransformation)
 
        # MimeData
        mimedata = QMimeData()
        url = QUrl().fromLocalFile(photoPath)
        mimedata.setUrls([url])
        mimedata.setImageData(image)
 
        # Set image in clipboard
        QApplication.clipboard().setImage(image)
 
        # Place Image and Refresh Canvas
        Krita.instance().action('edit_paste').trigger()
        Krita.instance().activeDocument().refreshProjection()
 
    def checkPath(self, path):
        if not os.path.isfile(path):
            if path in self.foundImages:
                self.foundImages.remove(path)
            if path in self.allImages:
                self.allImages.remove(path)
            if path in self.favouriteImages:
                self.favouriteImages.remove(path)
 
            dlg = QMessageBox(self)
            dlg.setWindowTitle("Missing Image!")
            dlg.setText("This image you tried to open was not found. Removing from the list.")
            dlg.exec()
 
            return False
 
        return True
 
    def openNewDocument(self, path):
        if not self.checkPath(path):
            self.updateImages()
            return 
 
        document = Krita.instance().openDocument(path)
        Application.activeWindow().addView(document)
 
    def placeReference(self, path):
        if not self.checkPath(path):
            self.updateImages()
            return
 
        # MimeData
        mimedata = QMimeData()
        url = QUrl().fromLocalFile(path)
        mimedata.setUrls([url])
        image = QImage(path)
        mimedata.setImageData(image)
 
        QApplication.clipboard().setImage(image)
        Krita.instance().action('paste_as_reference').trigger()
 
    def openPreview(self, path):
        self.imageWidget.setImage(path, self.getImage(path))
        self.layout.imageWidget.setSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Expanding)
        self.layout.middleWidget.setSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Ignored)
 
    def closePreview(self):
        self.layout.imageWidget.setSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Ignored)
        self.layout.middleWidget.setSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Expanding)
 
    def pinToFavourites(self, path):
        self.currPage = 0
        self.favouriteImages = [path] + self.favouriteImages
 
        # save setting for next restart
        Application.writeSetting(self.applicationName, self.foundFavouritesSetting, str(self.favouriteImages))
        self.reorganizeImages()
        self.updateImages()
 
    def unpinFromFavourites(self, path):
        if path in self.favouriteImages:
            self.favouriteImages.remove(path)
 
        Application.writeSetting(self.applicationName, self.foundFavouritesSetting, str(self.favouriteImages))
 
        # resets order to the default, but checks if foundImages is only a subset
        # in case it is searching
        orderedImages = []
        for image in self.allImages:
            if image in self.foundImages:
                orderedImages.append(image)
 
        self.foundImages = orderedImages
        self.reorganizeImages()
        self.updateImages()
 
    def leaveEvent(self, event):
        self.layout.filterTextEdit.clearFocus()
 
    def canvasChanged(self, canvas):
        pass
 
    def buttonClick(self, position):
        if position < len(self.foundImages) - len(self.imagesButtons) * self.currPage:
            self.addImageLayer(self.foundImages[position + len(self.imagesButtons) * self.currPage])
 
    def changePath(self):
        if self.directoryPath == "":
            dialogDirectory = QStandardPaths.writableLocation(QStandardPaths.StandardLocation.PicturesLocation)
        else:
            dialogDirectory = self.directoryPath
        self.directoryPath = FileDialog.getExistingDirectory(self.mainWidget, i18n("Change Directory for Images"), dialogDirectory)
        if not self.directoryPath: return
        Application.writeSetting(self.applicationName, self.referencesSetting, self.directoryPath)
 
        self.favouriteImages = []
        self.foundImages = []
 
        Application.writeSetting(self.applicationName, self.foundFavouritesSetting, "")
 
        if self.directoryPath == "":
            self.layout.changePathButton.setText(i18n("Set References Folder"))
        else:
            self.layout.changePathButton.setText(i18n("Change References Folder"))
        self.getImagesFromDirectory()