make smart colletion list more intelligent, put auto bookmark checking

behind a pref (disabled by default) (bug 231512)

camino/src/bookmarks/AddressBookManager.h

@@ -53,7 +53,7 @@
   id mAddressBookFolder;
 }
 
+-(id)initWithFolder:(id)folder;
 -(void)fillAddressBook:(NSNotification *)note;
 
-
 @end

camino/src/bookmarks/AddressBookManager.m

@@ -41,6 +41,8 @@
 * ***** END LICENSE BLOCK ***** */
 
 #import "AddressBookManager.h"
+#import "BookmarkFolder.h"
+#import "Bookmark.h"
 #import <AddressBook/AddressBook.h>
 
 

camino/src/bookmarks/BookmarkManager.h

@@ -48,14 +48,10 @@
 #define kBookmarkMenuContainerIndex 0
 #define kToolbarContainerIndex 1
 #define kHistoryContainerIndex 2
-#define kTop10ContainerIndex 3
-#define kBrokenBookmarkContainerIndex 4
-#define kRendezvousContainerIndex 5
-#define kAddressBookContainerIndex 6
 
 // check 1 bookmark every 2 minutes, but only if we haven't been there in a day
-#define kTimeSinceBookmarkLastChecked 86400.0
-#define kTimeToCheckAnotherBookmark 120  
+#define kTimeBeforeRecheckingBookmark 86400.0
+#define kTimeBetweenBookmarkChecks 120  
 
 @interface BookmarkManager : NSObject <BookmarksClient> {
   BookmarkFolder *mRootBookmarks;	// root bookmark object
@@ -64,6 +60,12 @@
   BookmarkImportDlgController *mImportDlgController;
   NSString *mPathToBookmarkFile; //exactly what it looks like
   NSTimer *mUpdateTimer; //we don't actually retain this
+  
+  // smart folders
+  BookmarkFolder *mTop10Container;
+  BookmarkFolder *mBrokenBookmarkContainer;
+  BookmarkFolder *mRendezvousContainer;
+  BookmarkFolder *mAddressBookContainer;
 }
 
 // Class Methods & shutdown stuff

camino/src/bookmarks/BookmarkManager.mm

@@ -113,9 +113,8 @@ static unsigned gFirstUserCollection = 0;
 //
 - (id)init
 {
-  if ((self = [super init]))
-  {
-BookmarkFolder* root = [[BookmarkFolder alloc] init];
+  if ((self = [super init])) {
+    BookmarkFolder* root = [[BookmarkFolder alloc] init];
     [root setParent:self];
     [root setIsRoot:YES];
     [root setTitle:NSLocalizedString(@"BookmarksRootName", @"")];
@@ -169,6 +168,10 @@ BookmarkFolder* root = [[BookmarkFolder alloc] init];
 
 -(void) dealloc
 {
+  [mTop10Container release];
+  [mBrokenBookmarkContainer release];
+  [mRendezvousContainer release];
+  [mAddressBookContainer release];
   [[NSNotificationCenter defaultCenter] removeObserver:self];
   if (mUpdateTimer)
     [mUpdateTimer invalidate]; //we don't retain this, so don't release it.
@@ -192,8 +195,9 @@ BookmarkFolder* root = [[BookmarkFolder alloc] init];
 {
   [[NSApp delegate] setupBookmarkMenus:gBookmarksManager];
   
-  // check update status of 1 bookmark every 2 minutes.
-  mUpdateTimer = [NSTimer scheduledTimerWithTimeInterval:kTimeToCheckAnotherBookmark target:self selector:@selector(checkForUpdates:) userInfo:nil repeats:YES];
+  // check update status of 1 bookmark every 2 minutes if autoupdate is enabled.
+  if ([[PreferenceManager sharedInstance] getBooleanPref:"camino.bookmarks.autoupdate" withSuccess:NULL])
+    mUpdateTimer = [NSTimer scheduledTimerWithTimeInterval:kTimeBetweenBookmarkChecks target:self selector:@selector(checkForUpdates:) userInfo:nil repeats:YES];
   [mSmartFolderManager postStartupInitialization:self];
   [[self toolbarFolder] refreshIcon];
 
@@ -224,32 +228,48 @@ BookmarkFolder* root = [[BookmarkFolder alloc] init];
 // We also have history, but that just points to the real history stuff.
 - (void)setupSmartCollections
 {
-  NSArray *names = nil;
-  if (floor(NSAppKitVersionNumber) <= NSAppKitVersionNumber10_1) //10.1
-    names = [[NSArray alloc] initWithObjects:
-      NSLocalizedString(@"History",@"History"),
-      NSLocalizedString(@"Top 10 List",@"Top 10 List"),
-      NSLocalizedString(@"Broken Bookmarks",@"Broken Bookmarks"),
-      nil];
-  else // 10.2 +
-    names = [[NSArray alloc] initWithObjects:
-      NSLocalizedString(@"History",@"History"),
-      NSLocalizedString(@"Top 10 List",@"Top 10 List"),
-      NSLocalizedString(@"Broken Bookmarks",@"Broken Bookmarks"),
-      NSLocalizedString(@"Rendezvous",@"Rendezvous"),
-      NSLocalizedString(@"Address Book",@"Address Book"),
-      nil];
-  gFirstUserCollection = [names count]+2;
-  unsigned i, j=[names count];
-  for (i=0; i < j; i++) {
-    BookmarkFolder *temp = [[BookmarkFolder alloc] init];
-    [temp setTitle:[names objectAtIndex:i]];
-    [temp setIsSmartFolder:YES];
-    [mRootBookmarks insertChild:temp atIndex:(i+2) isMove:NO];
-    [temp release];
+  int collectionIndex = 2;  //skip 0 and 1, the menu and toolbar folders
+  
+  // add history
+  BookmarkFolder *temp = [[BookmarkFolder alloc] init];
+  [temp setTitle:NSLocalizedString(@"History",@"History")];
+  [temp setIsSmartFolder:YES];
+  [mRootBookmarks insertChild:temp atIndex:(collectionIndex++) isMove:NO];
+  [temp release];
+  
+  // note: don't release the smart folders until dealloc, so they persist even if turned off and on
+  
+  // add top 10 list
+  mTop10Container = [[BookmarkFolder alloc] init];
+  [mTop10Container setTitle:NSLocalizedString(@"Top Ten List",@"Top Ten List")];
+  [mTop10Container setIsSmartFolder:YES];
+  [mRootBookmarks insertChild:mTop10Container atIndex:(collectionIndex++) isMove:NO];
+  
+  // add broken bookmarks if auto-checking is enabled
+  if ([[PreferenceManager sharedInstance] getBooleanPref:"camino.bookmarks.autoupdate" withSuccess:NULL]) {
+    mBrokenBookmarkContainer = [[BookmarkFolder alloc] init];
+    [mBrokenBookmarkContainer setTitle:NSLocalizedString(@"Broken Bookmarks",@"Broken Bookmarks")];
+    [mBrokenBookmarkContainer setIsSmartFolder:YES];
+    [mRootBookmarks insertChild:mBrokenBookmarkContainer atIndex:(collectionIndex++) isMove:NO];
   }
-  [names release];
+  
+  // add rendezvous and address book in 10.2+
+  if (floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_1) {
+    mRendezvousContainer = [[BookmarkFolder alloc] init];
+    [mRendezvousContainer setTitle:NSLocalizedString(@"Rendezvous",@"Rendezvous")];
+    [mRendezvousContainer setIsSmartFolder:YES];
+    [mRootBookmarks insertChild:mRendezvousContainer atIndex:(collectionIndex++) isMove:NO];
+    
+    mAddressBookContainer = [[BookmarkFolder alloc] init];
+    [mAddressBookContainer setTitle:NSLocalizedString(@"Address Book",@"Address Book")];
+    [mAddressBookContainer setIsSmartFolder:YES];
+    [mRootBookmarks insertChild:mAddressBookContainer atIndex:(collectionIndex++) isMove:NO];
+  }
+      
+  gFirstUserCollection = collectionIndex;
+  
   // set pretty icons
+  
   [[self historyFolder] setIcon:[NSImage imageNamed:@"historyicon"]];
   [[self top10Folder] setIcon:[NSImage imageNamed:@"top10_icon"]];
   [[self bookmarkMenuFolder] setIcon:[NSImage imageNamed:@"bookmarkmenu_icon"]];
@@ -295,12 +315,12 @@ BookmarkFolder* root = [[BookmarkFolder alloc] init];
 
 -(BookmarkFolder *)top10Folder
 {
-  return [[self rootBookmarks] objectAtIndex:kTop10ContainerIndex];
+  return mTop10Container;
 }
 
 -(BookmarkFolder *) brokenLinkFolder
 {
-  return [[self rootBookmarks] objectAtIndex:kBrokenBookmarkContainerIndex];
+  return mBrokenBookmarkContainer;
 }
 
 -(BookmarkFolder *) toolbarFolder
@@ -320,18 +340,12 @@ BookmarkFolder* root = [[BookmarkFolder alloc] init];
 
 -(BookmarkFolder *) rendezvousFolder
 {
-  if (floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_1)
-    return [[self rootBookmarks] objectAtIndex:kRendezvousContainerIndex];
-  else
-    return nil;  
+  return mRendezvousContainer;
 }
 
 -(BookmarkFolder *) addressBookFolder
 {
-  if (floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_1)
-    return [[self rootBookmarks] objectAtIndex:kAddressBookContainerIndex];
-  else
-    return nil;
+  return mAddressBookContainer;
 }
 
 -(NSUndoManager *) undoManager
@@ -404,7 +418,7 @@ BookmarkFolder* root = [[BookmarkFolder alloc] init];
   while ((!foundBookmark) && (aKid = [enumerator nextObject])) {
     if ([aKid isKindOfClass:[Bookmark class]]) {
       if (([(Bookmark *)aKid isCheckable]) &&
-          ([[(Bookmark *)aKid lastVisit] timeIntervalSinceNow] < -kTimeSinceBookmarkLastChecked))
+          (-[[(Bookmark *)aKid lastVisit] timeIntervalSinceNow] > kTimeBeforeRecheckingBookmark))
           foundBookmark = aKid;
     } else if ([aKid isKindOfClass:[BookmarkFolder class]])
       foundBookmark = [self findABookmarkToCheckInFolder:aKid];

camino/src/bookmarks/KindaSmartFolderManager.mm

@@ -49,6 +49,7 @@
 @interface KindaSmartFolderManager (Private) <NetworkServicesClient, BookmarksClient> 
 -(void)addBookmark:(Bookmark *)aBookmark toSmartFolder:(BookmarkFolder *)aFolder;
 -(void)removeBookmark:(Bookmark *)aBookmark fromSmartFolder:(BookmarkFolder *)aFolder;
+-(void)setupBrokenBookmarks;
 -(void)checkForNewTop10:(Bookmark *)aBookmark;
 -(void)setupAddressBook;
 -(void)rebuildTop10List;
@@ -95,12 +96,24 @@
   }
   if (mAddressBookFolder)
     [self setupAddressBook];
+  if (mBrokenBookmarkFolder)
+    [self setupBrokenBookmarks];
   // get top 10 list started
   NSArray *bookmarkArray = [[manager rootBookmarks] allChildBookmarks];
   unsigned i, j = [bookmarkArray count];
   for (i=0; i < j; i++) {
     Bookmark *aBookmark = [bookmarkArray objectAtIndex:i];
     [self checkForNewTop10:aBookmark];
+  }
+}
+
+-(void) setupBrokenBookmarks
+{
+  BookmarkManager *manager = [BookmarkManager sharedBookmarkManager];
+  NSArray *bookmarkArray = [[manager rootBookmarks] allChildBookmarks];
+  unsigned i, j = [bookmarkArray count];
+  for (i=0; i < j; i++) {
+    Bookmark *aBookmark = [bookmarkArray objectAtIndex:i];
     if ([aBookmark isSick])
       [self addBookmark:aBookmark toSmartFolder:mBrokenBookmarkFolder];
   }
@@ -183,6 +196,7 @@
 //
 -(void)addBookmark:(Bookmark *)aBookmark toSmartFolder:(BookmarkFolder *)aFolder
 {
+  if (aFolder == nil) return; //if the smart folder isn't enabled, we're done
   unsigned index = [aFolder indexOfObjectIdenticalTo:aBookmark];
   if (index == NSNotFound)
     [aFolder insertIntoSmartFolderChild:aBookmark];
@@ -192,6 +206,7 @@
 // 
 -(void)removeBookmark:(Bookmark *)anItem fromSmartFolder:(BookmarkFolder *)aFolder
 {
+  if (aFolder == nil) return; //if the smart folder isn't enabled, we're done
   unsigned index = [aFolder indexOfObjectIdenticalTo:anItem];
   if (index != NSNotFound)
     [aFolder deleteFromSmartFolderChildAtIndex:index];