feat(clipboard): allow configuration of clipboard save action directory

Author: keircn

src/server/src/extensions/clipboard/clipboard-history-command.cpp

@@ -26,5 +26,30 @@ std::vector<Preference> ClipboardHistoryCommand::preferences() const {
                                "if your environment supports it.");
   preferences.emplace_back(defaultAction);
 
+  using Opt = Preference::DropdownData::Option;
+
+  auto saveDirectoryMode = Preference::makeDropdown(
+      "saveDirectoryMode",
+      {Opt{"Downloads folder", "downloads"}, Opt{"Home folder", "home"}, Opt{"Custom folder", "custom"}});
+  saveDirectoryMode.setDefaultValue("downloads");
+  saveDirectoryMode.setTitle("Save Destination");
+  saveDirectoryMode.setDescription("Where clipboard entries are saved when using the Save to file action.");
+  preferences.emplace_back(saveDirectoryMode);
+
+  auto saveCustomDirectory = Preference::directory("saveCustomDirectory");
+  saveCustomDirectory.setTitle("Custom Save Folder");
+  saveCustomDirectory.setDescription("Used only when Save Destination is set to Custom folder.");
+  saveCustomDirectory.setRequired(false);
+  saveCustomDirectory.setDefaultValue(QJsonValue::Null);
+  preferences.emplace_back(saveCustomDirectory);
+
+  auto saveFileNameMode = Preference::makeDropdown(
+      "saveFileNameMode", {Opt{"Use content preview", "content"}, Opt{"Use timestamp", "timestamp"}});
+  saveFileNameMode.setDefaultValue("content");
+  saveFileNameMode.setTitle("Save Filename");
+  saveFileNameMode.setDescription(
+      "Choose whether generated save filenames come from the content or from timestamp.");
+  preferences.emplace_back(saveFileNameMode);
+
   return preferences;
 }

src/server/src/extensions/clipboard/history/clipboard-history-actions.hpp

@@ -47,6 +47,24 @@ class CopyClipboardSelection : public AbstractAction {
 
 class SaveClipboardSelectionToFileAction : public AbstractAction {
   ClipboardHistoryEntry m_entry;
+  QString m_saveDirectoryMode;
+  QString m_saveCustomDirectory;
+  QString m_saveFileNameMode;
+
+  QString kindToken() const {
+    switch (m_entry.kind) {
+    case ClipboardOfferKind::Image:
+      return "image";
+    case ClipboardOfferKind::File:
+      return "file";
+    case ClipboardOfferKind::Link:
+      return "link";
+    case ClipboardOfferKind::Text:
+      return "text";
+    default:
+      return "entry";
+    }
+  }
 
   static QStringList uriLines(const QByteArray &data) {
     QString const text = QString::fromUtf8(data);
@@ -117,6 +135,11 @@ class SaveClipboardSelectionToFileAction : public AbstractAction {
   }
 
   QString defaultFileStem(const QByteArray &data) const {
+    if (m_saveFileNameMode == "timestamp") {
+      auto dt = QDateTime::fromSecsSinceEpoch(m_entry.updatedAt);
+      return QString("clipboard-%1-%2").arg(kindToken()).arg(dt.toString("yyyyMMdd-HHmmss"));
+    }
+
     if (m_entry.kind == ClipboardOfferKind::Image) {
       auto dt = QDateTime::fromSecsSinceEpoch(m_entry.updatedAt);
       return QString("clipboard-image-%1").arg(dt.toString("yyyyMMdd-HHmmss"));
@@ -144,6 +167,17 @@ class SaveClipboardSelectionToFileAction : public AbstractAction {
   }
 
   QString saveDirectoryPath() const {
+    if (m_saveDirectoryMode == "custom") {
+      QString const custom = m_saveCustomDirectory.trimmed();
+      if (!custom.isEmpty()) return custom;
+    }
+
+    if (m_saveDirectoryMode == "home") {
+      auto folder = homeDir();
+      if (!folder.empty()) return QString::fromStdString(folder.string());
+      return QDir::homePath();
+    }
+
     auto folder = downloadsFolder();
     std::error_code ec;
     if (folder.empty() || !std::filesystem::is_directory(folder, ec)) { folder = homeDir(); }
@@ -209,8 +243,12 @@ class SaveClipboardSelectionToFileAction : public AbstractAction {
   }
 
 public:
-  explicit SaveClipboardSelectionToFileAction(const ClipboardHistoryEntry &entry)
-      : AbstractAction("Save to file", BuiltinIcon::SaveDocument), m_entry(entry) {}
+  SaveClipboardSelectionToFileAction(const ClipboardHistoryEntry &entry, QString saveDirectoryMode,
+                                     QString saveCustomDirectory, QString saveFileNameMode)
+      : AbstractAction("Save to file", BuiltinIcon::SaveDocument), m_entry(entry),
+        m_saveDirectoryMode(std::move(saveDirectoryMode)),
+        m_saveCustomDirectory(std::move(saveCustomDirectory)),
+        m_saveFileNameMode(std::move(saveFileNameMode)) {}
 };
 
 class RemoveSelectionAction : public AbstractAction {

src/server/src/qml/clipboard-history-model.cpp

@@ -116,7 +116,8 @@ std::unique_ptr<ActionPanelState> ClipboardHistoryModel::createActionPanel(int,
   auto dangerSection = panel->createSection();
   toolsSection->addAction(pin);
   if (isCopyable) {
-    auto saveToFile = new SaveClipboardSelectionToFileAction(entry);
+    auto saveToFile = new SaveClipboardSelectionToFileAction(entry, m_saveDirectoryMode,
+                                                             m_saveCustomDirectory, m_saveFileNameMode);
     saveToFile->setShortcut(Keybind::SaveAction);
     toolsSection->addAction(saveToFile);
   }

src/server/src/qml/clipboard-history-model.hpp

@@ -17,6 +17,9 @@ class ClipboardHistoryModel : public CommandListModel {
 
   void setEntries(const PaginatedResponse<ClipboardHistoryEntry> &page);
   void setDefaultAction(DefaultAction action) { m_defaultAction = action; }
+  void setSaveDirectoryMode(QString value) { m_saveDirectoryMode = std::move(value); }
+  void setSaveCustomDirectory(QString value) { m_saveCustomDirectory = std::move(value); }
+  void setSaveFileNameMode(QString value) { m_saveFileNameMode = std::move(value); }
   void resetSelectionOnNextUpdate() { setSelectFirstOnReset(true); }
   void setFilter(const QString &text) override {}
   QString searchPlaceholder() const override { return QStringLiteral("Browse clipboard history..."); }
@@ -40,4 +43,7 @@ class ClipboardHistoryModel : public CommandListModel {
 
   std::vector<ClipboardHistoryEntry> m_entries;
   DefaultAction m_defaultAction = DefaultAction::Copy;
+  QString m_saveDirectoryMode = "downloads";
+  QString m_saveCustomDirectory;
+  QString m_saveFileNameMode = "content";
 };

src/server/src/qml/clipboard-history-view-host.cpp

@@ -74,8 +74,15 @@ void ClipboardHistoryViewHost::initialize() {
 
   auto preferences = command()->preferenceValues();
   auto defaultActionStr = preferences.value("defaultAction").toString();
+  auto saveDirectoryMode = preferences.value("saveDirectoryMode").toString();
+  auto saveCustomDirectory = preferences.value("saveCustomDirectory").toString();
+  auto saveFileNameMode = preferences.value("saveFileNameMode").toString();
+
   m_model->setDefaultAction(defaultActionStr == "paste" ? ClipboardHistoryModel::DefaultAction::Paste
                                                         : ClipboardHistoryModel::DefaultAction::Copy);
+  m_model->setSaveDirectoryMode(saveDirectoryMode.isEmpty() ? "downloads" : saveDirectoryMode);
+  m_model->setSaveCustomDirectory(saveCustomDirectory);
+  m_model->setSaveFileNameMode(saveFileNameMode.isEmpty() ? "content" : saveFileNameMode);
 
   setSearchPlaceholderText("Browse clipboard history...");