File indexing completed on 2023-10-01 08:44:24

 /***************************************************************************
     smb4kbookmarkmenu  -  Bookmark menu
                              -------------------
     begin                : Sat Apr 02 2011
     copyright            : (C) 2011-2019 by Alexander Reinholdt
     email                : alexander.reinholdt@kdemail.net
  ***************************************************************************/
 
 /***************************************************************************
  *   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 Street, Suite 500, Boston,*
  *   MA 02110-1335, USA                                                    *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
 
 // application specific includes
 #include "smb4kbookmarkmenu.h"
 #include "core/smb4kbookmark.h"
 #include "core/smb4kshare.h"
 #include "core/smb4kbookmarkhandler.h"
 #include "core/smb4kmounter.h"
 #include "core/smb4ksettings.h"
 #include "core/smb4kglobal.h"
 
 // Qt includes
 #include <QDebug>
 #include <QMenu>
 #include <QLatin1String>
 
 // KDE includes
 #include <KIconThemes/KIconLoader>
 #include <KI18n/KLocalizedString>
 
 using namespace Smb4KGlobal;
 
 
 Smb4KBookmarkMenu::Smb4KBookmarkMenu(int type, QWidget *parentWidget, QObject *parent)
 : KActionMenu(KDE::icon("folder-favorites"), i18n("Bookmarks"), parent), m_type(type),
   m_parent_widget(parentWidget)
 {
   //
   // Set up the action group for the actions
   //
   m_actions = new QActionGroup(menu());
 
   // 
   // Set up the action group for the bookmarks
   // 
   m_bookmarks = new QActionGroup(menu());
 
   // Set up the menu
   setupMenu();
 
   // Connections
   connect(Smb4KBookmarkHandler::self(), SIGNAL(updated()), SLOT(slotBookmarksUpdated()));
   connect(Smb4KMounter::self(), SIGNAL(mounted(SharePtr)), SLOT(slotEnableBookmark(SharePtr)));
   connect(Smb4KMounter::self(), SIGNAL(unmounted(SharePtr)), SLOT(slotEnableBookmark(SharePtr)));
   connect(m_actions, SIGNAL(triggered(QAction*)), SLOT(slotGroupActionTriggered(QAction*)));
   connect(m_bookmarks, SIGNAL(triggered(QAction*)), SLOT(slotBookmarkActionTriggered(QAction*)));
 }
 
 
 Smb4KBookmarkMenu::~Smb4KBookmarkMenu()
 {
 }
 
 
 void Smb4KBookmarkMenu::refreshMenu()
 {
   //
   // Delete all entries from the menu
   //
   while (!menu()->actions().isEmpty())
   {
     QAction *action = menu()->actions().takeFirst();
     removeAction(action);
     delete action;
   }
   
   //
   // Clear the rest of the menu
   //
   if (!menu()->isEmpty())
   {
     menu()->clear();
   }
   
   //
   // Set up the menu
   //
   setupMenu();
   
   //
   // Make sure the correct menu entries are shown
   //
   menu()->update();
 }
 
 
 void Smb4KBookmarkMenu::setBookmarkActionEnabled(bool enable)
 {
   QAction *action = menu()->findChild<QAction *>("add_action");
     
   if (action)
   {
     action->setEnabled(enable);
   }
 }
 
 
 void Smb4KBookmarkMenu::setupMenu()
 {
   //
   // Depending on the type chosen, some global actions need to be inserted
   // into the menu. These actions are always enabled.
   //
   switch (m_type)
   {
     case MainWindow:
     {
       QAction *editBookmarksAction = new QAction(KDE::icon("bookmarks-organize"), i18n("&Edit Bookmarks"), menu());
       editBookmarksAction->setObjectName("edit_action");
       QMap<QString,QVariant> editInfo;
       editInfo["type"] = "edit";
       editBookmarksAction->setData(editInfo);
       connect(editBookmarksAction, SIGNAL(triggered(bool)), SLOT(slotEditActionTriggered(bool)));
       addAction(editBookmarksAction);
       m_actions->addAction(editBookmarksAction);
       
       QAction *addBookmarkAction = new QAction(KDE::icon("bookmark-new"), i18n("Add &Bookmark"), menu());
       addBookmarkAction->setObjectName("add_action");
       QMap<QString,QVariant> addInfo;
       addInfo["type"] = "add";
       addBookmarkAction->setData(addInfo);
       addBookmarkAction->setEnabled(false);
       connect(addBookmarkAction, SIGNAL(triggered(bool)), SLOT(slotAddActionTriggered(bool)));
       addAction(addBookmarkAction);
       m_actions->addAction(addBookmarkAction);
       
       break;
     }
     case SystemTray:
     {
       QAction *editBookmarksAction = new QAction(KDE::icon("bookmarks-organize"), i18n("&Edit Bookmarks"), menu());
       editBookmarksAction->setObjectName("edit_action");
       QMap<QString,QVariant> editInfo;
       editInfo["type"] = "edit";
       editBookmarksAction->setData(editInfo);
       connect(editBookmarksAction, SIGNAL(triggered(bool)), SLOT(slotEditActionTriggered(bool)));
       addAction(editBookmarksAction);
       m_actions->addAction(editBookmarksAction);
       
       break;      
     }
     default:
     {
       break;
     }
   }
   
   //
   // Get the list of groups
   //
   QStringList allGroups = Smb4KBookmarkHandler::self()->groupsList();
   allGroups.sort();
   
   //
   // Insert a toplevel mount action, if necessary. Crucial for this is that there are 
   // no (non-empty) groups defined. Enable it if not all toplevel bookmarks are mounted.
   //
   if (allGroups.isEmpty() || (allGroups.size() == 1 && allGroups.first().isEmpty()))
   {
     QAction *toplevelMount = new QAction(KDE::icon("media-mount"), i18n("Mount All Bookmarks"), menu());
     toplevelMount->setObjectName("toplevel_mount");
     QMap<QString,QVariant> mountInfo;
     mountInfo["type"] = "toplevel_mount";
     toplevelMount->setData(mountInfo);
     connect(toplevelMount, SIGNAL(triggered(bool)), SLOT(slotToplevelMountActionTriggered(bool)));
     addAction(toplevelMount);
     m_actions->addAction(toplevelMount);
     
     QList<BookmarkPtr> bookmarks = Smb4KBookmarkHandler::self()->bookmarksList();
     int mountedBookmarks = 0;
     
     for (const BookmarkPtr &bookmark : bookmarks)
     {
       QList<SharePtr> mountedShares = findShareByUrl(bookmark->url());
       
       if (!mountedShares.isEmpty())
       {
         for (const SharePtr &share : mountedShares)
         {
           if (!share->isForeign())
           {
             mountedBookmarks++;
             break;
           }
           else
           {
             continue;
           }
         }
       }
     }
     
     toplevelMount->setEnabled(mountedBookmarks != bookmarks.size());
   }
   
   //
   // Add a separator
   //
   addSeparator();
   
   //
   // Now add the groups and their bookmarks
   //
   for (const QString &group : allGroups)
   {
     if (!group.isEmpty())
     {
       // Group menu entry
       KActionMenu *bookmarkGroupMenu = new KActionMenu(group, menu());
       bookmarkGroupMenu->setIcon(KDE::icon("folder-favorites"));
       QMap<QString,QVariant> menuInfo;
       menuInfo["type"] = "group_menu";
       menuInfo["group"] = group;
       bookmarkGroupMenu->setData(menuInfo);
       addAction(bookmarkGroupMenu);
       
       // Mount action for the group
       QAction *bookmarkGroupMount = new QAction(KDE::icon("media-mount"), i18n("Mount All Bookmarks"), bookmarkGroupMenu->menu());
       QMap<QString,QVariant> groupMountInfo;
       groupMountInfo["type"] = "group_mount";
       groupMountInfo["group"] = group;
       bookmarkGroupMount->setData(groupMountInfo);
       bookmarkGroupMenu->addAction(bookmarkGroupMount);
       m_actions->addAction(bookmarkGroupMount);
       
       // Get the list of bookmarks belonging to this group.
       // Use it to decide whether the group mount action should be enabled 
       // (only if not all bookmarks belonging to this group are mounted) and
       // to sort the bookmarks.      
       QList<BookmarkPtr> bookmarks = Smb4KBookmarkHandler::self()->bookmarksList(group);
       QStringList sortedBookmarks;
       int mountedBookmarks = 0;
       
       for (const BookmarkPtr &bookmark : bookmarks)
       {
         QAction *bookmarkAction = 0;
         
         if (Smb4KSettings::showCustomBookmarkLabel() && !bookmark->label().isEmpty())
         {
           bookmarkAction = new QAction(bookmark->icon(), bookmark->label(), bookmarkGroupMenu->menu());
           bookmarkAction->setObjectName(bookmark->url().toDisplayString());
           QMap<QString,QVariant> bookmarkInfo;
           bookmarkInfo["type"] = "bookmark";
           bookmarkInfo["group"] = group;
           bookmarkInfo["url"] = bookmark->url();
           bookmarkInfo["text"] = bookmark->label();
           bookmarkAction->setData(bookmarkInfo);
           m_bookmarks->addAction(bookmarkAction);
           sortedBookmarks << bookmark->label();
         }
         else
         {
           bookmarkAction = new QAction(bookmark->icon(), bookmark->displayString(), bookmarkGroupMenu->menu());
           bookmarkAction->setObjectName(bookmark->url().toDisplayString());
           QMap<QString,QVariant> bookmarkInfo;
           bookmarkInfo["type"] = "bookmark";
           bookmarkInfo["group"] = group;
           bookmarkInfo["url"] = bookmark->url();
           bookmarkInfo["text"] = bookmark->displayString();
           bookmarkAction->setData(bookmarkInfo);
           m_bookmarks->addAction(bookmarkAction);
           sortedBookmarks << bookmark->displayString();
         }
         
         QList<SharePtr> mountedShares = findShareByUrl(bookmark->url());
         
         if (!mountedShares.isEmpty())
         {
           for (const SharePtr &share : mountedShares)
           {
             if (!share->isForeign())
             {
               bookmarkAction->setEnabled(false);
               mountedBookmarks++;
               break;
             }
             else
             {
               continue;
             }
           }
         }
       }
       
       bookmarkGroupMount->setEnabled(mountedBookmarks != bookmarks.size());
       sortedBookmarks.sort();
       
       // Add a separator
       bookmarkGroupMenu->addSeparator();
       
       // Insert the sorted bookmarks into the group menu
       QList<QAction *> actions = m_bookmarks->actions();
       
       for (const QString &b : sortedBookmarks)
       {
         for (QAction *a : actions)
         {
           if (a->text() == b)
           {
             bookmarkGroupMenu->addAction(a);
             break;
           }
           else
           {
             continue;
           }
         }
       }
     }
   }
   
   //
   // Add all bookmarks that have no group
   // Sort the bookmarks before.  
   //
   QList<BookmarkPtr> bookmarks = Smb4KBookmarkHandler::self()->bookmarksList("");
   QStringList sortedBookmarks;
   
   for (const BookmarkPtr &bookmark : bookmarks)
   {
     QAction *bookmarkAction = 0;
         
     if (Smb4KSettings::showCustomBookmarkLabel() && !bookmark->label().isEmpty())
     {
       bookmarkAction = new QAction(bookmark->icon(), bookmark->label(), menu());
       bookmarkAction->setObjectName(bookmark->url().toDisplayString());
       QMap<QString,QVariant> bookmarkInfo;
       bookmarkInfo["type"] = "bookmark";
       bookmarkInfo["group"] = "";
       bookmarkInfo["url"] = bookmark->url();
       bookmarkInfo["text"] = bookmark->label();
       bookmarkAction->setData(bookmarkInfo);
       m_bookmarks->addAction(bookmarkAction);
       sortedBookmarks << bookmark->label();
     }
     else
     {
       bookmarkAction = new QAction(bookmark->icon(), bookmark->displayString(), menu());
       bookmarkAction->setObjectName(bookmark->url().toDisplayString());
       QMap<QString,QVariant> bookmarkInfo;
       bookmarkInfo["type"] = "bookmark";
       bookmarkInfo["group"] = "";
       bookmarkInfo["url"] = bookmark->url();
       bookmarkInfo["text"] = bookmark->displayString();
       bookmarkAction->setData(bookmarkInfo);
       m_bookmarks->addAction(bookmarkAction);
       sortedBookmarks << bookmark->displayString();
     }
         
     QList<SharePtr> mountedShares = findShareByUrl(bookmark->url());
         
     if (!mountedShares.isEmpty())
     {
       for (const SharePtr &share : mountedShares)
       {
         if (!share->isForeign())
         {
           bookmarkAction->setEnabled(false);
           break;
         }
         else
         {
           continue;
         }
       }
     }
   }
   
   sortedBookmarks.sort();
   
   QList<QAction *> actions = m_bookmarks->actions();
       
   for (const QString &b : sortedBookmarks)
   {
     for (QAction *a : actions)
     {
       if (a->data().toMap().value("text").toString() == b)
       {
         addAction(a);
         break;
       }
       else
       {
         continue;
       }
     }
   }
 }
 
 
 /////////////////////////////////////////////////////////////////////////////
 // SLOT IMPLEMENTATIONS
 /////////////////////////////////////////////////////////////////////////////
 
 void Smb4KBookmarkMenu::slotEditActionTriggered(bool /*checked*/)
 {
   Smb4KBookmarkHandler::self()->editBookmarks();
 }
 
 
 void Smb4KBookmarkMenu::slotAddActionTriggered(bool /*checked*/)
 {
   emit addBookmark();
 }
 
 
 void Smb4KBookmarkMenu::slotToplevelMountActionTriggered(bool /*checked*/)
 {
   //
   // Mount all top level bookmarks.
   // This slot will only be called if there are no groups defined.
   //
   QList<BookmarkPtr> bookmarks = Smb4KBookmarkHandler::self()->bookmarksList();
   QList<SharePtr> mounts;
 
   for (const BookmarkPtr &bookmark : bookmarks)
   {
     // FIXME: Check if the bookmarked share has already been mounted.
     SharePtr share = SharePtr(new Smb4KShare());
     share->setHostName(bookmark->hostName());
     share->setShareName(bookmark->shareName());
     share->setWorkgroupName(bookmark->workgroupName());
     share->setHostIpAddress(bookmark->hostIpAddress());
     share->setLogin(bookmark->login());
     mounts << share;
   }
 
   Smb4KMounter::self()->mountShares(mounts);
 
   while (!mounts.isEmpty())
   {
     mounts.takeFirst().clear();
   }
 }
 
 
 void Smb4KBookmarkMenu::slotGroupActionTriggered(QAction *action)
 {
   if (action->data().toMap().value("type").toString() == "group_mount")
   {
     //
     // Mount all bookmarks of one group
     //
     QList<BookmarkPtr> bookmarks = Smb4KBookmarkHandler::self()->bookmarksList(action->data().toMap().value("group").toString());
     QList<SharePtr> mounts;
 
     for (const BookmarkPtr &bookmark : bookmarks)
     {
       // FIXME: Check if the bookmarked share has already been mounted.
       SharePtr share = SharePtr(new Smb4KShare());
       share->setHostName(bookmark->hostName());
       share->setShareName(bookmark->shareName());
       share->setWorkgroupName(bookmark->workgroupName());
       share->setHostIpAddress(bookmark->hostIpAddress());
       share->setLogin(bookmark->login());
       mounts << share;
     }
 
     Smb4KMounter::self()->mountShares(mounts);
 
     while (!mounts.isEmpty())
     {
       mounts.takeFirst().clear();
     }
   }
 }
 
 
 void Smb4KBookmarkMenu::slotBookmarkActionTriggered(QAction *action)
 {
   QMap<QString,QVariant> info = action->data().toMap();
   QString bookmarkGroup = info.value("group").toString();
   QUrl url = info.value("url").toUrl();
   
   BookmarkPtr bookmark = Smb4KBookmarkHandler::self()->findBookmarkByUrl(url);
 
   if (bookmark && bookmarkGroup == bookmark->groupName())
   {
     SharePtr share = SharePtr(new Smb4KShare());
     share->setHostName(bookmark->hostName());
     share->setShareName(bookmark->shareName());
     share->setWorkgroupName(bookmark->workgroupName());
     share->setHostIpAddress(bookmark->hostIpAddress());
     share->setLogin(bookmark->login());
     Smb4KMounter::self()->mountShare(share);
     share.clear();
   }
 }
 
 
 void Smb4KBookmarkMenu::slotBookmarksUpdated()
 {
   refreshMenu();
 }
 
 
 void Smb4KBookmarkMenu::slotEnableBookmark(const SharePtr &share)
 {
   if (!share->isForeign() && !m_bookmarks->actions().isEmpty())
   {
     //
     // Enable or disable the bookmark
     //
     QList<QAction *> actions = m_bookmarks->actions();
     QString bookmarkGroup;
     
     for (QAction *a : actions)
     {
       QUrl bookmarkUrl = a->data().toMap().value("url").toUrl();
       
       if (share->url().matches(bookmarkUrl, QUrl::RemoveUserInfo|QUrl::RemovePort))
       {
         a->setEnabled(!share->isMounted());
         bookmarkGroup = a->data().toMap().value("group").toString();
         break;
       }
     }
     
     //
     // Check if all bookmarks belonging to this group are 
     // mounted. Enable the respective mount action if necessary.
     //
     bool allMounted = true;
       
     for (QAction *a : actions)
     {
       if (a->data().toMap().value("group").toString() == bookmarkGroup && a->isEnabled())
       {
         allMounted = false;
         break;
       }
       else
       {
         continue;
       }
     }
       
     QList<QAction *> allActions = m_actions->actions();
       
     for (QAction *a : allActions)
     {
       if (a->data().toMap().value("type").toString() == "toplevel_mount" && bookmarkGroup.isEmpty())
       {
         a->setEnabled(!allMounted);
         break;
       }
       else if (a->data().toMap().value("type").toString() == "group_mount" &&
                a->data().toMap().value("group").toString() == bookmarkGroup)
       {
         a->setEnabled(!allMounted);
         break;
       }
       else
       {
         continue;
       }
     }
   }
 }