# This file is part of the Frescobaldi project, http://www.frescobaldi.org/ # # Copyright (c) 2008, 2009, 2010 by Wilbert Berendsen # # 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 2 # 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, write to the Free Software # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA # See http://www.gnu.org/licenses/ for more information. from __future__ import unicode_literals """ Actions (that can be performed on files generated by running LilyPond) """ import os, sip from subprocess import Popen, PIPE from PyQt4.QtCore import QSize, Qt from PyQt4.QtGui import ( QKeySequence, QLabel, QListWidget, QListWidgetItem, QMenu, QPrinter, QToolButton) from PyKDE4.kdecore import KGlobal, KShell, KToolInvocation, KUrl, i18n, i18np from PyKDE4.kdeui import ( KdePrint, KDialog, KIcon, KMessageBox, KStandardGuiItem, KVBox) from PyKDE4.kio import KRun import ly.parse from kateshell.mainwindow import addAccelerators # Easily get our global config def config(group): return KGlobal.config().group(group) class ActionManager(object): def __init__(self, mainwin): self.mainwin = mainwin def addActionsToMenu(self, updatedFiles, menu): """ Queries updatedFiles() and adds corresponding actions to the menu. """ # PDFs pdfs = updatedFiles("pdf") for pdf in pdfs: name = '"{0}"'.format(os.path.basename(pdf)) a = menu.addAction(KIcon("application-pdf"), i18n("Open %1 in external viewer", name)) a.triggered.connect((lambda pdf: lambda: self.openPDF(pdf))(pdf)) if pdfs: menu.addSeparator() # MIDIs midis = updatedFiles("mid*") for midi in midis: name = '"{0}"'.format(os.path.basename(midi)) a = menu.addAction(KIcon("media-playback-start"), i18n("Play %1", name)) a.triggered.connect((lambda midi: lambda: self.openMIDI(midi))(midi)) if not pdfs and not midis: a = menu.addAction( i18n("(No up-to-date MIDI or PDF files available.)")) a.setToolTip(i18n( "There are no up-to-date MIDI or PDF files available. " "Please run LilyPond to create one or more output files.")) else: addAccelerators(menu.actions()) def addActionsToLog(self, updatedFiles, log): """ Queries updatedFiles() and adds corresponding actions to the log. See runlily.py for the LogWidget """ bar = log.actionBar bar.clear() # clear all actions def make_action(items, func, icon, title): if items: icon = KIcon(icon) a = bar.addAction(icon, title) if len(items) == 1: a.triggered.connect((lambda item: lambda: func(item))(items[0])) else: menu = QMenu(bar.widgetForAction(a)) a.setMenu(menu) bar.widgetForAction(a).setPopupMode(QToolButton.InstantPopup) sip.transferto(menu, None) # let C++ take ownership for item in items: a = menu.addAction(icon, os.path.basename(item)) a.triggered.connect((lambda item: lambda: func(item))(item)) pdfs = updatedFiles("pdf") make_action(pdfs, self.openPDF, "application-pdf", i18n("Open PDF")) make_action(pdfs, self.printPDF, "document-print", i18n("Print")) make_action(updatedFiles("mid*"), self.openMIDI, "media-playback-start", i18n("Play MIDI")) # if any actions were added, also add the email action and show. if len(bar.actions()) > 0: a = bar.addAction(KIcon("mail-send"), i18n("Email...")) a.setToolTip("{0} ({1})".format(a.toolTip(), a.shortcut().toString())) a.triggered.connect(lambda: self.email(updatedFiles, log.preview)) log.checkScroll(bar.show) def openPDF(self, fileName): """ Opens a PDF in the configured external PDF viewer, or in the KDE default one. """ openPDF(fileName, self.mainwin) def openMIDI(self, fileName): """ Opens a MIDI in the configured external MIDI player, or in the KDE default one. """ openMIDI(fileName, self.mainwin) def printPDF(self, pdfFileName): """ Prints the PDF using the configured print command """ printPDF(pdfFileName, self.mainwin) def openDirectory(self, path=None): """ Opens a folder. If None, opes the document folder if any, or else the current working directory in the default KDE file manager. """ if path is None: d = self.mainwin.currentDocument() if d.url().isEmpty(): if d.localFileManager(): path = d.localFileManager().directory else: path = self.mainwin.app.defaultDirectory() or os.getcwd() else: path = d.url().resolved(KUrl('.')) url = KUrl(path) url.adjustPath(KUrl.RemoveTrailingSlash) sip.transferto(KRun(url, self.mainwin), None) # C++ will delete it def email(self, updatedFiles, warnpreview=False): """ Collects updated files and provides a nice dialog to send them. If warnpreview, the user is warned because he/she would send a PDF with point-and-click links in it. The PDFs are MUCH larger in that case. """ if os.path.exists(updatedFiles.lyfile): EmailDialog(self.mainwin, updatedFiles, warnpreview).exec_() else: KMessageBox.sorry(self.mainwin, i18n("There are no files to send via email."), i18n("No files to send")) def print_(self, updatedFiles): """ Print updated PDF files. If there are no updated PDF's a warning is displayed. If there is one updated PDF, the print dialog is displayed. If there is more than one PDF, a dialog is displayed to select the files to print. """ pdfs = updatedFiles("pdf") if not pdfs: KMessageBox.sorry(self.mainwin, i18n( "There are no PDF documents to print.\n\n" "You probably need to run LilyPond to create or update a " "PDF document. If you are creating MIDI files, be sure you " "also put a \layout { } section in your score, otherwise " "LilyPond will not create a PDF."), i18n("No files to print")) elif len(pdfs) == 1: printPDF(pdfs[0], self.mainwin) else: PrintSelectDialog(self.mainwin, pdfs).exec_() class EmailDialog(KDialog): def __init__(self, parent, updatedFiles, warnpreview): KDialog.__init__(self, parent) self.setAttribute(Qt.WA_DeleteOnClose) self.setButtons(KDialog.ButtonCode(KDialog.Ok | KDialog.Cancel)) self.setCaption(i18n("Email documents")) self.showButtonSeparator(True) b = KVBox(self) b.setSpacing(4) QLabel(i18n("Please select the files you want to send:"), b) fileList = QListWidget(b) fileList.setIconSize(QSize(22, 22)) fileList.setWhatsThis(i18n( "These are the files that are up-to-date (i.e. newer than " "the LilyPond source document). Also LilyPond files included " "by the source document are shown.")) lyFiles = ly.parse.findIncludeFiles(updatedFiles.lyfile, config("preferences").readPathEntry("lilypond include path", [])) pdfFiles = updatedFiles("pdf") midiFiles = updatedFiles("mid*") if warnpreview and pdfFiles: QLabel(i18np( "Note: this PDF file has been created with " "embedded point-and-click URLs (preview mode), which " "increases the file size dramatically. " "Please consider to rebuild the file in publish mode, " "because then the PDF file is much smaller.", "Note: these PDF files have been created with " "embedded point-and-click URLs (preview mode), which " "increases the file size dramatically. " "Please consider to rebuild the files in publish mode, " "because then the PDF files are much smaller.", len(pdfFiles)), b).setWordWrap(True) if not pdfFiles and not midiFiles: QLabel(i18n( "Note: If there are no PDF and no MIDI files, you " "probably need to run LilyPond to update those files, " "before sending the e-mail."), b).setWordWrap(True) self.fileList = fileList self.setMainWidget(b) self.resize(450, 300) basedir = os.path.dirname(updatedFiles.lyfile) exts = config("general").readEntry("email_extensions", [".pdf"]) def item(icon, fileName): """ Add item to the fileList list widget. """ directory, name = os.path.split(fileName) if directory != basedir: name += " ({0})".format(os.path.normpath(directory)) i = QListWidgetItem(KIcon(icon), name, fileList) i.setFlags(Qt.ItemIsEnabled | Qt.ItemIsSelectable | Qt.ItemIsUserCheckable) i.ext = os.path.splitext(fileName)[1] i.url = KUrl.fromPath(fileName).url() i.setCheckState(Qt.Checked if i.ext in exts else Qt.Unchecked) # insert the files for lyfile in lyFiles: item("text-x-lilypond", lyfile) for pdf in pdfFiles: item("application-pdf", pdf) for midi in midiFiles: item("audio-midi", midi) def selectedItems(self): """ Yields all checked items. """ for row in range(self.fileList.count()): item = self.fileList.item(row) if item.checkState() == Qt.Checked: yield item def done(self, result): if result: # Save selected extensions to preselect next time. exts = list(set(item.ext for item in self.selectedItems())) config("general").writeEntry("email_extensions", exts) urls = [item.url for item in self.selectedItems()] emailFiles(urls) KDialog.done(self, result) class PrintSelectDialog(KDialog): def __init__(self, mainwin, pdfs): KDialog.__init__(self, mainwin) self.mainwin = mainwin self.setAttribute(Qt.WA_DeleteOnClose) self.setButtons(KDialog.ButtonCode( KDialog.User1 | KDialog.Ok | KDialog.Cancel)) self.setButtonGuiItem(KDialog.Ok, KStandardGuiItem.print_()) self.setButtonIcon(KDialog.User1, KIcon("edit-select-all")) self.setButtonText(KDialog.User1, i18n("Select all")) self.setCaption(i18n("Print documents")) b = KVBox(self) b.setSpacing(4) QLabel(i18n("Please select the files you want to print:"), b) fileList = QListWidget(b) fileList.setIconSize(QSize(22, 22)) fileList.setWhatsThis(i18n( "These are the PDF documents that are up-to-date (i.e. newer than " "the LilyPond source document). " "Check the documents you want to send to the printer.")) for pdf in pdfs: i = QListWidgetItem(KIcon("application-pdf"), os.path.basename(pdf), fileList) i.setFlags(Qt.ItemIsEnabled | Qt.ItemIsSelectable | Qt.ItemIsUserCheckable) i.setCheckState(Qt.Unchecked) fileList.item(0).setCheckState(Qt.Checked) self.fileList = fileList self.setMainWidget(b) self.resize(350, 200) self.pdfs = pdfs self.user1Clicked.connect(self.selectAll) def selectAll(self): for i in range(self.fileList.count()): self.fileList.item(i).setCheckState(Qt.Checked) def done(self, result): pdfs = [] if result: for i, pdf in zip(range(self.fileList.count()), self.pdfs): if self.fileList.item(i).checkState() == Qt.Checked: pdfs.append(pdf) KDialog.done(self, result) if pdfs: printPDFs(pdfs, self.mainwin) def openPDF(fileName, window): """ Opens a PDF in the configured external PDF viewer, or in the KDE default one. """ openFile(fileName, window, config("commands").readEntry("pdf viewer", "")) def openMIDI(fileName, window): """ Opens a MIDI in the configured external MIDI player, or in the KDE default one. """ openFile(fileName, window, config("commands").readEntry("midi player", "")) def openFile(fileName, window, cmd = None): """ Opens a file with command cmd (string, read from config) or with the KDE default application (via KRun). """ if cmd: cmd, err = KShell.splitArgs(cmd) if err == KShell.NoError: cmd.append(fileName) try: Popen(cmd) return except OSError: pass # let C++ own the KRun object, it will delete itself. sip.transferto(KRun(KUrl.fromPath(fileName), window), None) def printPDF(pdfFileName, window, printer=None): """Prints the given PDF file. See printPDFs for more information. """ printPDFs([pdfFileName], window, printer) def printPDFs(pdfFileNames, window, printer=None): """Prints the give list of PDF files. If printer (a QPrinter instance) is not given, a print dialog is opened. """ if not pdfFileNames: return # don't do anything on an empty list. if printer is None: # open a dialog if len(pdfFileNames) == 1: printer = getPrinter(window, i18n("Print %1", os.path.basename(pdfFileNames[0]))) else: printer = getPrinter(window, i18np("Print 1 file", "Print %1 files", len(pdfFileNames)), allowPrintToFile=False) if not printer: return # cancelled import kateshell.fileprinter try: kateshell.fileprinter.printFiles(pdfFileNames, printer) except kateshell.fileprinter.NoPrintCommandFound: KMessageBox.error(window, i18n( "A print command (like 'lpr' or 'lp') could not be found on your " "system.")) except kateshell.fileprinter.CommandNotFound as e: KMessageBox.error(window, i18n( "The command '%1' could not be found on your system.", e.args[0])) except kateshell.fileprinter.CommandFailed as e: cmd, ret = e.args KMessageBox.error(window, i18n( "The command below has been run, but exited with a return code %1." "\n\n%2", ret, cmd)) def getPrinter(window, caption=None, printer=None, allowPrintToFile=True): """Opens a Print Dialog and waits for user interaction. If the dialog is accepted, the configured printer (a QPrinter) is returned, otherwise None. window is the parent window for the print dialog. If printer is given, it must be a QPrinter instance. If allowPrintToFile=False, printing to a file is not allowed. """ if printer is None: printer = QPrinter() dlg = KdePrint.createPrintDialog(printer, window) if caption: dlg.setWindowTitle(KDialog.makeStandardCaption(caption)) dlg.setOption(dlg.PrintToFile, allowPrintToFile) if dlg.exec_(): return printer def emailFiles(urls): """ Open the default mailer with the given urls (list of str) attached. """ to, cc, bcc, subject, body, msgfile = '', '', '', '', '', '' KToolInvocation.invokeMailer(to, cc, bcc, subject, body, msgfile, urls)