File indexing completed on 2024-05-19 05:05:48

 /***************************************************************************
  *   SPDX-License-Identifier: GPL-2.0-or-later
  *                                                                         *
  *   SPDX-FileCopyrightText: 2004-2019 Thomas Fischer <fischer@unix-ag.uni-kl.de>
  *                                                                         *
  *   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, see <https://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #include "lyx.h"
 
 #include <QWidget>
 #include <QAction>
 #include <QDir>
 #include <QTextStream>
 #include <QFileInfo>
 #include <QStandardPaths>
 #include <qplatformdefs.h>
 
 #include <KActionCollection>
 #include <KLocalizedString>
 #include <KParts/ReadOnlyPart>
 #include <KMessageBox>
 
 #include <Preferences>
 
 class LyX::LyXPrivate
 {
 public:
     QWidget *widget;
     QAction *action;
     QStringList references;
 
     LyXPrivate(LyX *parent, QWidget *widget)
             : action(nullptr) {
         Q_UNUSED(parent)
         this->widget = widget;
     }
 
     QString locateConfiguredLyXPipe() {
         QString result;
 
         /// First, check if automatic detection is disabled.
         /// In this case, read the LyX pipe's path from configuration
         if (!Preferences::instance().lyXUseAutomaticPipeDetection())
             result = Preferences::instance().lyXPipePath();
 
 #ifdef QT_LSTAT
         /// Check if the result so far is empty. This means that
         /// either automatic detection is enabled or the path in
         /// the configuration is empty/invalid. Proceed with
         /// automatic detection in this case.
         if (result.isEmpty())
             result = LyX::guessLyXPipeLocation();
 #endif // QT_LSTAT
 
         /// Finally, even if automatic detection was preferred by the user,
         /// still check configuration for a path if automatic detection failed
         if (result.isEmpty() && Preferences::instance().lyXUseAutomaticPipeDetection())
             result = Preferences::instance().lyXPipePath();
 
         /// Return the best found LyX pipe path
         return result;
     }
 };
 
 
 LyX::LyX(KParts::ReadOnlyPart *part, QWidget *widget)
         : QObject(part), d(new LyX::LyXPrivate(this, widget))
 {
     d->action = new QAction(QIcon::fromTheme(QStringLiteral("application-x-lyx")), i18n("Send to LyX/Kile"), this);
     part->actionCollection()->addAction(QStringLiteral("sendtolyx"), d->action);
     d->action->setEnabled(false);
     connect(d->action, &QAction::triggered, this, &LyX::sendReferenceToLyX);
     widget->addAction(d->action);
 }
 
 LyX::~LyX()
 {
     delete d;
 }
 
 void LyX::setReferences(const QStringList &references)
 {
     d->references = references;
     d->action->setEnabled(d->widget != nullptr && !d->references.isEmpty());
 }
 
 void LyX::sendReferenceToLyX()
 {
     const QString defaultHintOnLyXProblems = i18n("\n\nCheck that LyX or Kile are running and configured to receive references.");
     const QString msgBoxTitle = i18n("Send Reference to LyX");
     /// LyX pipe name has to determined always fresh in case LyX or Kile exited
     const QString pipeName = d->locateConfiguredLyXPipe();
 
     if (pipeName.isEmpty()) {
         KMessageBox::error(d->widget, i18n("No 'LyX server pipe' was detected.") + defaultHintOnLyXProblems, msgBoxTitle);
         return;
     }
 
     if (d->references.isEmpty()) {
         KMessageBox::error(d->widget, i18n("No references to send to LyX/Kile."), msgBoxTitle);
         return;
     }
 
     QFile pipe(pipeName);
     if (!QFileInfo::exists(pipeName) || !pipe.open(QFile::WriteOnly)) {
         KMessageBox::error(d->widget, i18n("Could not open LyX server pipe '%1'.", pipeName) + defaultHintOnLyXProblems, msgBoxTitle);
         return;
     }
 
     QTextStream ts(&pipe);
     QString msg = QString(QStringLiteral("LYXCMD:kbibtex:citation-insert:%1")).arg(d->references.join(QStringLiteral(",")));
 
 #if QT_VERSION >= 0x050e00
     ts << msg << Qt::endl;
 #else // QT_VERSION < 0x050e00
     ts << msg << endl;
 #endif // QT_VERSION >= 0x050e00
     ts.flush();
 
     pipe.close();
 }
 
 #ifdef QT_LSTAT
 QString LyX::guessLyXPipeLocation()
 {
     QT_STATBUF statBuffer;
     const QStringList nameFilter {QStringLiteral("*lyxpipe*in*")};
     const QVector<QDir> directoriesToScan {QDir::home(), QDir(QDir::homePath() + QStringLiteral("/.lyx")), QDir::temp()};
     for (const QDir &directory : directoriesToScan) {
         const QStringList files = directory.entryList(nameFilter, QDir::Hidden | QDir::System | QDir::Writable, QDir::Unsorted);
         for (const QString &filename : files) {
             const QString canonicalFilename = QFileInfo(directory.absolutePath() + QDir::separator() + filename).canonicalFilePath();
             if (QT_LSTAT(canonicalFilename.toLatin1().constData(), &statBuffer) == 0 && S_ISFIFO(statBuffer.st_mode))
                 return canonicalFilename;
         }
     }
 
     return QString();
 }
 #endif // QT_LSTAT