dolphin/keditbookmarks/toplevel.cpp

/* This file is part of the KDE project
   Copyright (C) 2000 David Faure <faure@kde.org>

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public
   License version 2 as published by the Free Software Foundation.

   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; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.
*/

#include "toplevel.h"
#include <kaction.h>
#include <kbookmarkmanager.h>
#include <kdebug.h>
#include <kstdaction.h>
#include <klocale.h>
#include <kmessagebox.h>
#include <klistview.h>
#include <krun.h>
#include <kiconloader.h>
#include <kapp.h>
#include <dcopclient.h>

// #define DEBUG_ADDRESSES

class KEBListViewItem : public QListViewItem
{
public:
    // toplevel item (there should be only one!)
    KEBListViewItem(QListView *parent, const KBookmark & group, const QString & s1 )
        : QListViewItem(parent, s1 ), m_bookmark(group)
    {
#ifdef DEBUG_ADDRESSES
        setText(2, bk.address());
#endif
    }

    // bookmark (first of its group)
    KEBListViewItem(KEBListViewItem *parent, const KBookmark & bk )
        : QListViewItem(parent, bk.fullText(), bk.url()), m_bookmark(bk)
    {
        setPixmap(0, SmallIcon( bk.icon() ) );
#ifdef DEBUG_ADDRESSES
        setText(2, bk.address());
#endif
    }

    // bookmark (after another)
    KEBListViewItem(KEBListViewItem *parent, QListViewItem *after, const KBookmark & bk )
        : QListViewItem(parent, after, bk.fullText(), bk.url()), m_bookmark(bk)
    {
        setPixmap(0, SmallIcon( bk.icon() ) );
#ifdef DEBUG_ADDRESSES
        setText(2, bk.address());
#endif
    }

    // group
    KEBListViewItem(KEBListViewItem *parent, QListViewItem *after, const KBookmarkGroup & gp )
        : QListViewItem(parent, after, gp.fullText()), m_bookmark(gp)
    {
        setPixmap(0, SmallIcon( gp.icon() ) );
#ifdef DEBUG_ADDRESSES
        setText(2, gp.address());
#endif
    }

    const KBookmark & bookmark() { return m_bookmark; }
private:
    KBookmark m_bookmark;
};

KEBTopLevel::KEBTopLevel( const QString & bookmarksFile )
    : KMainWindow()
{
    // Create the bookmark manager.
    // It will be available in KBookmarkManager::self() from now.
    (void) new KBookmarkManager( bookmarksFile, false );

    // Create the list view
    m_pListView = new KListView( this );
    m_pListView->setDragEnabled( true );
    m_pListView->addColumn( i18n("Bookmark"), 300 );
    m_pListView->addColumn( i18n("URL"), 300 );
#ifdef DEBUG_ADDRESSES
    m_pListView->addColumn( "Address", 100 );
#endif

    m_pListView->setRootIsDecorated( true );
    m_pListView->setRenameable( 0 );
    m_pListView->setRenameable( 1 );
    m_pListView->setItemsRenameable( true );
    m_pListView->setItemsMovable( true );
    m_pListView->setAcceptDrops( true );
    m_pListView->setAllColumnsShowFocus( true );
    m_pListView->setMinimumHeight(400);
    m_pListView->setSorting(-1, false);
    setCentralWidget( m_pListView );

    connect( m_pListView, SIGNAL(itemRenamed(QListViewItem *, const QString &, int)),
             SLOT(slotItemRenamed(QListViewItem *, const QString &, int)) );
    connect( m_pListView, SIGNAL(moved (QListViewItem *, QListViewItem *, QListViewItem *)),
             SLOT(slotMoved(QListViewItem *, QListViewItem *, QListViewItem *)) );
    connect( m_pListView, SIGNAL(selectionChanged( QListViewItem * ) ),
             SLOT(slotSelectionChanged( QListViewItem * ) ) );
    connect( m_pListView, SIGNAL(contextMenu( KListView *, QListViewItem *, const QPoint & )),
             SLOT(slotContextMenu( KListView *, QListViewItem *, const QPoint & )) );
    // If someone plays with konq's bookmarks while we're open, update.
    connect( KBookmarkManager::self(), SIGNAL(changed(const QString &) ),
             SLOT( fillListView() ) );
    fillListView();

    // Create the actions

    // TODO importNS (icon : "netscape")
    (void) KStdAction::save( this, SLOT( slotSave() ), actionCollection() );
    (void) KStdAction::close( this, SLOT( close() ), actionCollection() );
    (void) KStdAction::undo( this, SLOT( slotUndo() ), actionCollection() );
    (void) new KAction( i18n( "&Delete" ), "editdelete", SHIFT+Key_Delete, this, SLOT( slotDelete() ), actionCollection(), "edit_delete" );
    (void) new KAction( i18n( "&Rename" ), "text", Key_F2, this, SLOT( slotRename() ), actionCollection(), "edit_rename" );
    (void) new KAction( i18n( "&Create New Folder" ), "folder_new", CTRL+Key_N, this, SLOT( slotNewFolder() ), actionCollection(), "edit_newfolder" );
    (void) new KAction( i18n( "&Insert separator" ), CTRL+Key_I, this, SLOT( slotInsertSeparator() ), actionCollection(), "edit_insertseparator" );
    (void) new KAction( i18n( "&Sort alphabetically" ), 0, this, SLOT( slotSort() ), actionCollection(), "edit_sort" );
    (void) new KAction( i18n( "Set As &Toolbar Folder" ), 0, this, SLOT( slotSetAsToolbar() ), actionCollection(), "edit_setastoolbar" );
    (void) new KAction( i18n( "&Open Link" ), "fileopen", 0, this, SLOT( slotOpenLink() ), actionCollection(), "edit_openlink" );
    (void) new KAction( i18n( "Test &Link" ), "bookmark", 0, this, SLOT( slotTestLink() ), actionCollection(), "edit_testlink" );
    // TODO change icon (calls KIconDialog) ?
    m_taShowNS = new KToggleAction( i18n( "Show Netscape Bookmarks" ), 0, this, SLOT( slotShowNS() ), actionCollection(), "settings_showNS" );
    m_taShowNS->setEnabled(false); // not implemented
    // TODO m_taShowNS->setChecked(....)

    actionCollection()->action("edit_undo")->setEnabled(false); // not implemented
    actionCollection()->action("edit_sort")->setEnabled(false); // not implemented
    actionCollection()->action("edit_testlink")->setEnabled(false); // not implemented

    slotSelectionChanged(0);

    createGUI();

    setModified(false); // for a nice caption
}

KEBTopLevel::~KEBTopLevel()
{

}

void KEBTopLevel::slotSave()
{
    (void)save();
}

bool KEBTopLevel::save()
{
    bool ok = KBookmarkManager::self()->save();
    if (ok)
    {
        QByteArray data;
        // We don't want to notify ourselves (keditbookmarks), because this would
        // call fillListView, which would seem to close all folders.
        // There's probably a better solution, but not at 4:47am.
        kapp->dcopClient()->send( "konqueror*", "KBookmarkManager", "notifyCompleteChange()", data );
        kapp->dcopClient()->send( "kdesktop", "KBookmarkManager", "notifyCompleteChange()", data );
        setModified( false );
    }
    return ok;
}

void KEBTopLevel::slotUndo()
{

}

void KEBTopLevel::slotRename()
{
    ASSERT( m_pListView->selectedItem() );
    m_pListView->rename( m_pListView->selectedItem(), 0 );
}

void KEBTopLevel::slotDelete()
{
    KBookmark bk = selectedBookmark();
    kdDebug() << "KEBTopLevel::slotDelete child count=" << bk.internalElement().childNodes().count() << endl;
    if ( bk.isGroup() && bk.internalElement().childNodes().count() > 1 /*there's always "TEXT"*/ )
    {
        if ( KMessageBox::questionYesNo( this, i18n("This is a bookmark folder. Are you sure you want to delete it ?"),
                                         i18n("Confirmation required") ) == KMessageBox::No )
            return;
    }
    bk.parentGroup().deleteBookmark(bk);
    delete m_pListView->selectedItem();
    setModified();
}

void KEBTopLevel::slotNewFolder()
{
    KEBListViewItem * kebItem = static_cast<KEBListViewItem *>(m_pListView->selectedItem());
    ASSERT( kebItem );
    KBookmark bk = kebItem->bookmark();
    ASSERT( bk.isGroup() );
    KBookmarkGroup group = bk.toGroup();
    // Ask user for a name, and insert in dom tree
    KBookmarkGroup newGroup = group.createNewFolder();
    if (!newGroup.isNull())
    {
        // Create GUI for the new item - last in its group
        QListViewItem * child = kebItem->firstChild();
        while( child && child->nextSibling() )
            child = child->nextSibling();

        (void) new KEBListViewItem( kebItem, child, newGroup );
        setModified();
    }
}

void KEBTopLevel::slotInsertSeparator()
{
    KEBListViewItem * kebItem = static_cast<KEBListViewItem *>(m_pListView->selectedItem());
    ASSERT( kebItem );
    KBookmark bk = kebItem->bookmark();
    ASSERT( bk.isGroup() );
    KBookmarkGroup group = bk.toGroup();

    KBookmark separator = group.createNewSeparator();
    if (!separator.isNull())
    {
        // Create GUI for the new item - last in its group
        QListViewItem * child = kebItem->firstChild();
        while( child && child->nextSibling() )
            child = child->nextSibling();

        (void) new KEBListViewItem( kebItem, child, separator );
        setModified();
    }
}

void KEBTopLevel::slotSort()
{

}

void KEBTopLevel::slotSetAsToolbar()
{
    KBookmarkGroup oldToolbar = KBookmarkManager::self()->toolbar();
    if (!oldToolbar.isNull())
        oldToolbar.internalElement().removeAttribute( "TOOLBAR" );
    KBookmark bk = selectedBookmark();
    ASSERT( bk.isGroup() );
    bk.internalElement().setAttribute( "TOOLBAR", "1" );
    // This doesn't appear in the GUI currently, so nothing to update...
    // ### How to show this in the GUI ?
    // Netscape has a special icon for it.
    setModified();
}

void KEBTopLevel::slotOpenLink()
{
    KBookmark bk = selectedBookmark();
    ASSERT( !bk.isGroup() );
    (void) new KRun( bk.url() );
}

void KEBTopLevel::slotTestLink()
{

}

void KEBTopLevel::slotShowNS()
{

}

void KEBTopLevel::setModified( bool modified )
{
    m_bModified = modified;
    setCaption( i18n("Bookmark Editor"), m_bModified );
    actionCollection()->action("file_save")->setEnabled( m_bModified );
}

KBookmark KEBTopLevel::selectedBookmark() const
{
    QListViewItem * item = m_pListView->selectedItem();
    ASSERT(item);
    KEBListViewItem * kebItem = static_cast<KEBListViewItem *>(item);
    return kebItem->bookmark();
}

void KEBTopLevel::slotItemRenamed(QListViewItem * item, const QString & newText, int column)
{
    ASSERT(item);
    KEBListViewItem * kebItem = static_cast<KEBListViewItem *>(item);
    KBookmark bk = kebItem->bookmark();
    switch (column) {
        case 0:
            if ( bk.fullText() != newText )
            {
                if (bk.isGroup())
                {
                    // QDom is very nice. All in one line :)
                    bk.internalElement().elementsByTagName("TEXT").item(0).firstChild().toText().setData( newText );
                }
                else
                    bk.internalElement().firstChild().toText().setData( newText );
                setModified();
            }
            break;
        case 1:
            if ( bk.url() != newText )
            {
                bk.internalElement().setAttribute("URL", newText);
                setModified();
            }
            break;
        default:
            kdWarning() << "No such column " << column << endl;
            break;
    }
}

void KEBTopLevel::slotMoved(QListViewItem *_item, QListViewItem * /*_afterFirst*/, QListViewItem *_afterNow)
{
    // The whole moving-items thing is screwed up in KListView
    // Try moving something as the first item of a group -> will be inserted as
    // the sibling instead.
    // It should be like netscape, where you can drop between items or _on_ a
    // group, which sets as first item of the group. I'm afraid it means a
    // "new parent" item in the signal

    //kdDebug() << "KEBTopLevel::slotMoved _item=" << _item << " _afterFirst=" << _afterFirst << " _afterNow=" << _afterNow << endl;
    KEBListViewItem * item = static_cast<KEBListViewItem *>(_item);
    KEBListViewItem * afterNow = static_cast<KEBListViewItem *>(_afterNow);
    if (!afterNow) // Not allowed to drop something before the root item !
    {
        kdDebug() << "Refilling" << endl;
        // We need to undo what KListView did
        // m_pListView->moveItem( _item, argl not enough info
        // Let's schedule a full refill then (can't do it now, klistview will need the items !)
        QTimer::singleShot( 0, this, SLOT(fillListView()));
        return;
    }
    KBookmarkGroup newParent = afterNow->bookmark().parentGroup();
    if (newParent.isNull())
    {
        // newParent can be null, if afterNow is the root item. In this case, set as first child
        // This is a very special case, in fact. The more generic solution would be to
        // allow insertions into a group. See above.
        m_pListView->takeItem( item );
        m_pListView->firstChild()->insertItem( item );
        afterNow->bookmark().internalElement().insertBefore( item->bookmark().internalElement(), QDomNode() );
    }
    else
    {
        QDomNode result = newParent.internalElement().insertAfter( item->bookmark().internalElement(), afterNow->bookmark().internalElement() );
        ASSERT(!result.isNull());
    }
    setModified();
}

void KEBTopLevel::slotSelectionChanged( QListViewItem * item )
{
    bool itemSelected = (item != 0L);
    bool group = false;
    bool separator = false;
    if ( itemSelected )
    {
        KEBListViewItem * kebItem = static_cast<KEBListViewItem *>(item);
        group = kebItem->bookmark().isGroup();
        separator = kebItem->bookmark().isSeparator();
    }

    KActionCollection * coll = actionCollection();

    coll->action("edit_rename")->setEnabled(itemSelected && !separator);
    coll->action("edit_delete")->setEnabled(itemSelected);
    coll->action("edit_newfolder")->setEnabled(group);
    coll->action("edit_insertseparator")->setEnabled(group);
    //coll->action("edit_sort")->setEnabled(group); // not implemented
    coll->action("edit_setastoolbar")->setEnabled(group);
    coll->action("edit_openlink")->setEnabled(itemSelected && !group && !separator);
    //coll->action("edit_testlink")->setEnabled(itemSelected && !group && !separator); // not implemented
}

void KEBTopLevel::slotContextMenu( KListView *, QListViewItem * _item, const QPoint &p )
{
    if (_item)
    {
        KEBListViewItem * item = static_cast<KEBListViewItem *>(_item);
        if ( item->bookmark().isGroup() )
        {
            QWidget* popup = factory()->container("popup_folder", this);
            if ( popup )
                static_cast<QPopupMenu*>(popup)->popup(p);
        }
        else
        {
            QWidget* popup = factory()->container("popup_bookmark", this);
            if ( popup )
                static_cast<QPopupMenu*>(popup)->popup(p);
        }
    }
}

void KEBTopLevel::fillListView()
{
    m_pListView->clear();
    KBookmarkGroup root = KBookmarkManager::self()->root();
    // Create root item
    KEBListViewItem * rootItem = new KEBListViewItem( m_pListView, root, i18n("Bookmarks") );
    rootItem->setPixmap(0, SmallIcon("bookmark"));
    // Maybe we could reimplement setOpen and fill the groups
    // only when we want to see them ? Not sure it makes a big difference though.
    fillGroup( rootItem, root );
    rootItem->setOpen(true);
}

void KEBTopLevel::fillGroup( KEBListViewItem * parentItem, KBookmarkGroup group )
{
    KEBListViewItem * lastItem = 0L;
    for ( KBookmark bk = group.first() ; !bk.isNull() ; bk = group.next(bk) )
    {
        //kdDebug() << "KEBTopLevel::fillGroup group=" << group.text() << " bk=" << bk.text() << endl;
        if ( bk.isGroup() )
        {
            KBookmarkGroup grp = bk.toGroup();
            KEBListViewItem * item = new KEBListViewItem( parentItem, lastItem, grp );
            fillGroup( item, grp );
            lastItem = item;
        }
        else
        {
            lastItem = new KEBListViewItem( parentItem, lastItem, bk );
        }
    }
}

bool KEBTopLevel::queryClose()
{
    if (m_bModified)
    {
        switch ( KMessageBox::warningYesNoCancel( this,
                                                  i18n("Save changes ?")) ) {
            case KMessageBox::Yes :
                return save();
            case KMessageBox::No :
                return true;
            default: // cancel
                return false;
        }
    }
    return true;
}

#include "toplevel.moc"