src/DirectoryTreeCtrl.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2003-2008 aMule Team ( admin@amule.org / http://www.amule.org )
   5 // Copyright (c) 2003 Robert Rostek ( tecxx@rrs.at )
   6 // Copyright (c) 2002 Merkur ( devs@emule-project.net / http://www.emule-project.net )
   7 //
   8 // Any parts of this program derived from the xMule, lMule or eMule project,
   9 // or contributed by third-party developers are copyrighted by their
  10 // respective authors.
  11 //
  12 // This program is free software; you can redistribute it and/or modify
  13 // it under the terms of the GNU General Public License as published by
  14 // the Free Software Foundation; either version 2 of the License, or
  15 // (at your option) any later version.
  16 //
  17 // This program is distributed in the hope that it will be useful,
  18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 // GNU General Public License for more details.
  21 //
  22 // You should have received a copy of the GNU General Public License
  23 // along with this program; if not, write to the Free Software
  24 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  25 //
  26
  27 #include "DirectoryTreeCtrl.h"  // Interface declarations
  28
  29 #include <wx/app.h>
  30 #include <wx/filename.h>
  31 #include <wx/imaglist.h>
  32
  33 #include <common/StringFunctions.h>
  34 #include <common/FileFunctions.h>
  35 #include "muuli_wdr.h"          // Needed for amuleSpecial
  36
  37
  38 BEGIN_EVENT_TABLE(CDirectoryTreeCtrl, wxTreeCtrl)
  39         EVT_TREE_ITEM_RIGHT_CLICK(wxID_ANY,     CDirectoryTreeCtrl::OnRButtonDown)
  40         EVT_TREE_ITEM_ACTIVATED(wxID_ANY,       CDirectoryTreeCtrl::OnItemActivated)
  41         EVT_TREE_ITEM_EXPANDED(wxID_ANY,        CDirectoryTreeCtrl::OnItemExpanding)
  42 END_EVENT_TABLE()
  43
  44
  45 class CItemData : public wxTreeItemData
  46 {
  47         public:
  48                 CItemData(const CPath& pathComponent)
  49                         : m_data(0)
  50                         , m_path(pathComponent)
  51                 {
  52                 }
  53
  54                 ~CItemData() {}
  55
  56                 void AddCount() { m_data++; }
  57                 void SubCount() { m_data--; }
  58                 int GetCount() const { return m_data; }
  59                 const CPath& GetPathComponent() const { return m_path; }
  60         private:
  61                 int     m_data;
  62                 CPath   m_path;
  63 };
  64
  65
  66 CDirectoryTreeCtrl::CDirectoryTreeCtrl(wxWindow* parent, int id, const wxPoint& pos, wxSize siz, int flags)
  67         : wxTreeCtrl(parent,id,pos,siz,flags,wxDefaultValidator,wxT("ShareTree"))
  68 {
  69         Init();
  70 }
  71
  72
  73 CDirectoryTreeCtrl::~CDirectoryTreeCtrl()
  74 {
  75 }
  76
  77 enum {
  78         IMAGE_FOLDER = 0,
  79         IMAGE_FOLDER_SUB_SHARED
  80 };
  81
  82
  83 void CDirectoryTreeCtrl::Init()
  84 {
  85         // init image(s)
  86         wxImageList* images = new wxImageList(16, 16);
  87         images->Add(wxBitmap(amuleSpecial(1)));
  88         images->Add(wxBitmap(amuleSpecial(2)));
  89         // Gives wxTreeCtrl ownership of the list
  90         AssignImageList(images);
  91
  92
  93         // Create an empty root item, which we can
  94         // safely append when creating a full path.
  95         wxTreeItemId root = AddRoot(wxEmptyString, IMAGE_FOLDER, -1,
  96                                         new CItemData(CPath()));
  97
  98
  99 #ifndef __WXMSW__
 100         AddChildItem(root, CPath(wxT("/")));
 101 #else
 102         for (char drive = 'C'; drive <= 'Z'; drive++) {
 103                 wxString driveStr = wxString::Format(wxT("%c:"), drive);
 104
 105                 if (CPath::DirExists(driveStr)) {
 106                         AddChildItem(root, CPath(driveStr));
 107                 }
 108         }
 109 #endif
 110
 111         HasChanged = false;
 112 }
 113
 114
 115 void CDirectoryTreeCtrl::OnItemExpanding(wxTreeEvent& evt)
 116 {
 117         wxTreeItemId hItem = evt.GetItem();
 118
 119         // Force reloading of the path
 120         DeleteChildren(hItem);
 121         AddSubdirectories(hItem, GetFullPath(hItem));
 122
 123         SortChildren(hItem);
 124 }
 125
 126
 127 void CDirectoryTreeCtrl::OnItemActivated(wxTreeEvent& evt)
 128 {
 129         CheckChanged(evt.GetItem(), !IsBold(evt.GetItem()));
 130         HasChanged = true;
 131 }
 132
 133
 134 void CDirectoryTreeCtrl::OnRButtonDown(wxTreeEvent& evt)
 135 {
 136         MarkChildren(evt.GetItem(), !IsBold(evt.GetItem()));
 137         HasChanged = true;
 138 }
 139
 140
 141 void CDirectoryTreeCtrl::MarkChildren(wxTreeItemId hChild, bool mark)
 142 {
 143         // Ensure that children are added, otherwise we might only get a "." entry.
 144         if (!IsExpanded(hChild) && ItemHasChildren(hChild)) {
 145                 DeleteChildren(hChild);
 146                 AddSubdirectories(hChild, GetFullPath(hChild));
 147                 SortChildren(hChild);
 148         }
 149
 150         wxTreeItemIdValue cookie;
 151         wxTreeItemId hChild2 = GetFirstChild(hChild, cookie);
 152         while (hChild2.IsOk()) {
 153                 MarkChildren(hChild2, mark);
 154
 155                 hChild2 = GetNextSibling(hChild2);
 156         }
 157
 158         CheckChanged(hChild, mark);
 159 }
 160
 161
 162 void CDirectoryTreeCtrl::AddChildItem(wxTreeItemId hBranch, const CPath& item)
 163 {
 164         wxCHECK_RET(hBranch.IsOk(), wxT("Attempted to add children to invalid item"));
 165
 166         CPath fullPath = GetFullPath(hBranch).JoinPaths(item);
 167         wxTreeItemId treeItem = AppendItem(hBranch, item.GetPrintable(),
 168                                                 IMAGE_FOLDER, -1,
 169                                                 new CItemData(item));
 170
 171         if (IsShared(fullPath)) {
 172                 SetItemBold(treeItem, true);
 173                 UpdateParentItems(treeItem, true);
 174         }
 175
 176         if (HasSharedSubdirectory(fullPath)) {
 177                 SetItemImage(treeItem, IMAGE_FOLDER_SUB_SHARED);
 178         }
 179
 180         if (HasSubdirectories(fullPath)) {
 181                 // Trick. will show + if it has subdirs
 182                 AppendItem(treeItem, wxT("."));
 183         }
 184 }
 185
 186
 187 CPath CDirectoryTreeCtrl::GetFullPath(wxTreeItemId hItem)
 188 {
 189         wxCHECK_MSG(hItem.IsOk(), CPath(), wxT("Invalid item in GetFullPath"));
 190
 191         CPath result;
 192         for (; hItem.IsOk(); hItem = GetItemParent(hItem)) {
 193                 CItemData* data = dynamic_cast<CItemData*>(GetItemData(hItem));
 194                 wxCHECK_MSG(data, CPath(), wxT("Missing data-item in GetFullPath"));
 195
 196                 result = data->GetPathComponent().JoinPaths(result);
 197         }
 198
 199         return result;
 200 }
 201
 202
 203 void CDirectoryTreeCtrl::AddSubdirectories(wxTreeItemId hBranch, const CPath& path)
 204 {
 205         wxCHECK_RET(path.IsOk(), wxT("Invalid path in AddSubdirectories"));
 206
 207         CDirIterator sharedDir(path);
 208
 209         CPath dirName = sharedDir.GetFirstFile(CDirIterator::Dir);
 210         while (dirName.IsOk()) {
 211                 AddChildItem(hBranch, dirName);
 212
 213                 dirName = sharedDir.GetNextFile();
 214         }
 215 }
 216
 217
 218 bool CDirectoryTreeCtrl::HasSubdirectories(const CPath& folder)
 219 {
 220         // Prevent error-messages if we try to traverse somewhere we have no access.
 221         wxLogNull logNo;
 222
 223         return CDirIterator(folder).HasSubDirs();
 224 }
 225
 226
 227 void CDirectoryTreeCtrl::GetSharedDirectories(PathList* list)
 228 {
 229         wxCHECK_RET(list, wxT("Invalid list in GetSharedDirectories"));
 230
 231         list->insert(list->end(), m_lstShared.begin(), m_lstShared.end());
 232 }
 233
 234
 235 void CDirectoryTreeCtrl::SetSharedDirectories(PathList* list)
 236 {
 237         wxCHECK_RET(list, wxT("Invalid list in SetSharedDirectories"));
 238
 239         m_lstShared.clear();
 240         m_lstShared.insert(m_lstShared.end(), list->begin(), list->end());
 241
 242         // Mark all shared root items (on windows this can be multiple
 243         // drives, on unix there is only the root dir).
 244         wxTreeItemIdValue cookie;
 245         wxTreeItemId hChild = GetFirstChild(GetRootItem(), cookie);
 246
 247         while (hChild.IsOk()) {
 248                 // Does this drive have shared subfolders?
 249                 if (HasSharedSubdirectory(GetFullPath(hChild))) {
 250                         SetItemImage(hChild, IMAGE_FOLDER_SUB_SHARED);
 251                 }
 252
 253                 // Is this drive shared?
 254                 if (IsShared(GetFullPath(hChild))) {
 255                         SetItemBold(hChild, true);
 256                 }
 257
 258                 hChild = GetNextSibling(hChild);
 259         }
 260 }
 261
 262
 263 bool CDirectoryTreeCtrl::HasSharedSubdirectory(const CPath& path)
 264 {
 265         PathList::iterator it = m_lstShared.begin();
 266         for (; it != m_lstShared.end(); ++it) {
 267                 // IsSameDir to avoid the case where 'path' itself is shared.
 268                 if (it->StartsWith(path) && (!it->IsSameDir(path))) {
 269                         return true;
 270                 }
 271         }
 272
 273         return false;
 274 }
 275
 276
 277 void CDirectoryTreeCtrl::CheckChanged(wxTreeItemId hItem, bool bChecked)
 278 {
 279         if (IsBold(hItem) != bChecked) {
 280                 SetItemBold(hItem, bChecked);
 281
 282                 if (bChecked) {
 283                         AddShare(GetFullPath(hItem));
 284                 } else {
 285                         DelShare(GetFullPath(hItem));
 286                 }
 287
 288                 UpdateParentItems(hItem, bChecked);
 289         }
 290 }
 291
 292
 293 bool CDirectoryTreeCtrl::IsShared(const CPath& path)
 294 {
 295         wxCHECK_MSG(path.IsOk(), false, wxT("Invalid path in IsShared"));
 296
 297         PathList::iterator it = m_lstShared.begin();
 298         for (; it != m_lstShared.end(); ++it) {
 299                 if (it->IsSameDir(path)) {
 300                         return true;
 301                 }
 302         }
 303
 304         return false;
 305 }
 306
 307
 308 void CDirectoryTreeCtrl::AddShare(const CPath& path)
 309 {
 310         wxCHECK_RET(path.IsOk(), wxT("Invalid path in AddShare"));
 311
 312         if (IsShared(path)) {
 313                 return;
 314         }
 315
 316         m_lstShared.push_back(path);
 317 }
 318
 319
 320 void CDirectoryTreeCtrl::DelShare(const CPath& path)
 321 {
 322         wxCHECK_RET(path.IsOk(), wxT("Invalid path in DelShare"));
 323
 324         PathList::iterator it = m_lstShared.begin();
 325         for (; it != m_lstShared.end(); ++it ) {
 326                 if (it->IsSameDir(path)) {
 327                         m_lstShared.erase(it);
 328                         return;
 329                 }
 330         }
 331 }
 332
 333
 334 void CDirectoryTreeCtrl::UpdateParentItems(wxTreeItemId hChild, bool add)
 335 {
 336         wxTreeItemId parent = hChild;
 337         while (parent != GetRootItem()) {
 338                 parent = GetItemParent(parent);
 339                 CItemData* parent_data = dynamic_cast<CItemData*>(GetItemData(parent));
 340                 if (add) {
 341                         parent_data->AddCount();
 342                         if (parent_data->GetCount()==1) {
 343                                 SetItemImage(parent, IMAGE_FOLDER_SUB_SHARED);
 344                         }
 345                 } else {
 346                         switch (parent_data->GetCount()) {
 347                                 case 0:
 348                                         break;
 349                                 case 1:
 350                                         SetItemImage(parent, IMAGE_FOLDER);
 351                                 default:
 352                                         parent_data->SubCount();
 353                                         break;
 354                         }
 355                 }
 356         };
 357 }
 358 // File_checked_for_headers