DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Untracked file

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Places.
 *
 * The Initial Developer of the Original Code is
 * Google Inc.
 * Portions created by the Initial Developer are Copyright (C) 2005
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Annie Sullivan <annie.sullivan@gmail.com> (original author)
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsILivemarkService.h"
#include "nsIStringBundle.h"
#include "nsIAnnotationService.h"
#include "nsNavHistory.h"
#include "nsBrowserCompsCID.h"
#include "nsILoadGroup.h"
#include "nsIObserver.h"

/**
 * This annotation's value is a string containing the URI of the
 * source feed for the given livemark.  It should be attached to the URI
 * of the livemark container.
 */
#define LMANNO_FEEDURI     "livemark/feedURI"

/**
 * This annotation's value is a string containing the URI of the
 * website associated with the source feed for the given livemark.
 * It should be attached to the URI of the livemark container.
 */
#define LMANNO_SITEURI     "livemark/siteURI"

/**
 * This annotation's value is an Int64 representing the time
 * (in milliseconds since January 1, 1970 GMT) when a
 * livemark feed should expire and thus have its associated livemark
 * refreshed.  It should be attached to the URI of the livemark's
 * source feed.
 */
#define LMANNO_EXPIRATION  "livemark/expiration"

/**
 * This annotation's value is a string containing the URI of the
 * syndication feed which was this source for a livemark item.
 * It should be attached to the URI of a livemark item (that is, a
 * child of a livemark container).
 */
#define LMANNO_BMANNO      "livemark/bookmarkFeedURI"

class nsIRDFResource;

class nsLivemarkService : public nsILivemarkService, public nsIObserver
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIREMOTECONTAINER
  NS_DECL_NSILIVEMARKSERVICE
  NS_DECL_NSIOBSERVER

  nsLivemarkService();
  nsresult Init();

  static nsLivemarkService* GetLivemarkService() {
    if (!sInstance) {
      nsresult rv;
      nsCOMPtr<nsILivemarkService> serv(do_GetService(NS_LIVEMARKSERVICE_CONTRACTID, &rv));
      NS_ENSURE_SUCCESS(rv, nsnull);
      NS_ASSERTION(sInstance, "Should have static instance pointer now");
    }
    return sInstance;
  }

  // These functions are called by the livemarks feed loader
  // to set the livemark children.
  nsresult DeleteLivemarkChildren(PRInt64 aLivemarkFolderId);
  nsresult InsertLivemarkChild(PRInt64 aLivemarkFolderId, 
                               nsIURI *aURI,
                               const nsAString &aTitle,
                               const nsAString &aFeedURI);
  nsresult InsertLivemarkLoadingItem(PRInt64 aFolder);
  nsresult InsertLivemarkFailedItem(PRInt64 aFolder);

  struct LivemarkInfo {
    PRInt64 folderId;
    nsCOMPtr<nsIURI> folderURI;
    nsCOMPtr<nsIURI> feedURI;
    PRBool locked;
    // Keep track of the load group that contains the channel we're using
    // to load this livemark.  This allows the load to be cancelled if
    // necessary.  The load group automatically adds redirect channels, so
    // cancelling the load group cancels everything.
    nsCOMPtr<nsILoadGroup> loadGroup;

    LivemarkInfo(PRInt64 aFolderId, nsIURI *aFolderURI, nsIURI *aFeedURI)
      : folderId(aFolderId), folderURI(aFolderURI), feedURI(aFeedURI),
        locked(PR_FALSE) { }

    void AddRef() { ++mRefCnt; }
    void Release() { if (--mRefCnt == 0) delete this; }

  private:
    nsAutoRefCnt mRefCnt;
  };

  nsCOMPtr<nsIRDFResource>       mLMRDF_type;
  nsCOMPtr<nsIRDFResource>       mLMRSS09_channel;
  nsCOMPtr<nsIRDFResource>       mLMRSS09_item;
  nsCOMPtr<nsIRDFResource>       mLMRSS09_title;
  nsCOMPtr<nsIRDFResource>       mLMRSS09_link;
  nsCOMPtr<nsIRDFResource>       mLMRSS10_channel;
  nsCOMPtr<nsIRDFResource>       mLMRSS10_items;
  nsCOMPtr<nsIRDFResource>       mLMRSS10_title;
  nsCOMPtr<nsIRDFResource>       mLMRSS10_link;
  nsCOMPtr<nsIRDFResource>       mLMDC_date;
private:
  static nsLivemarkService *sInstance;

  ~nsLivemarkService();

  // remove me when there is better query initialization
  nsNavHistory* History() { return nsNavHistory::GetHistoryService(); }

  // For localized "livemark loading...", "livemark failed to load", 
  // etc. messages
  nsCOMPtr<nsIStringBundle> mBundle;
  nsXPIDLString mLivemarkLoading;
  nsXPIDLString mLivemarkFailed;

  nsCOMPtr<nsIURI> mIconURI;

  nsCOMPtr<nsIAnnotationService> mAnnotationService;

  // The list of livemarks is stored in this array
  nsTArray< nsRefPtr<LivemarkInfo> > mLivemarks;

  // Livemarks are updated on a timer.
  nsCOMPtr<nsITimer> mTimer;
  static void FireTimer(nsITimer* aTimer, void* aClosure);
  nsresult UpdateLivemarkChildren(PRInt32 aLivemarkIndex, PRBool aForceUpdate);
  PRInt32 GetLivemarkIndex(PRInt64 folderID);

};