File: nsLocalStore.cpp

package info (click to toggle)
thunderbird 1:60.8.0-1~deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,339,208 kB
  • sloc: cpp: 5,456,704; ansic: 2,360,384; python: 596,095; asm: 340,963; java: 326,291; xml: 258,664; sh: 84,366; makefile: 23,702; perl: 17,317; objc: 3,768; yacc: 1,766; ada: 1,681; lex: 1,364; pascal: 1,264; cs: 879; exp: 527; php: 436; lisp: 258; ruby: 153; awk: 152; sed: 53; csh: 27
file content (420 lines) | stat: -rw-r--r-- 13,064 bytes parent folder | download | duplicates (7)
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* vim: set cindent tabstop=4 expandtab shiftwidth=4: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/*

  Implementation for the local store

 */

#include "nsNetUtil.h"
#include "nsIFile.h"
#include "nsIURI.h"
#include "nsIIOService.h"
#include "nsIOutputStream.h"
#include "nsIComponentManager.h"
#include "nsILocalStore.h"
#include "nsIRDFDataSource.h"
#include "nsIRDFRemoteDataSource.h"
#include "nsIRDFService.h"
#include "nsIServiceManager.h"
#include "nsRDFCID.h"
#include "nsString.h"
#include "plstr.h"
#include "rdf.h"
#include "nsCOMPtr.h"
#include "nsWeakPtr.h"
#include "nsAppDirectoryServiceDefs.h"
#include "nsIObserver.h"
#include "nsIObserverService.h"
#include "nsWeakReference.h"
#include "nsCRTGlue.h"
#include "nsCRT.h"
#include "nsEnumeratorUtils.h"
#include "nsCycleCollectionParticipant.h"

////////////////////////////////////////////////////////////////////////

class LocalStoreImpl : public nsILocalStore,
                       public nsIRDFDataSource,
                       public nsIRDFRemoteDataSource,
                       public nsIObserver,
                       public nsSupportsWeakReference {
 protected:
  nsCOMPtr<nsIRDFDataSource> mInner;

  LocalStoreImpl();
  virtual ~LocalStoreImpl();
  nsresult Init();
  nsresult CreateLocalStore(nsIFile* aFile);
  nsresult LoadData();

  friend nsresult NS_NewLocalStore(nsISupports* aOuter, REFNSIID aIID,
                                   void** aResult);

  nsCOMPtr<nsIRDFService> mRDFService;

 public:
  // nsISupports interface
  NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(LocalStoreImpl, nsILocalStore)

  // nsILocalStore interface

  // nsIRDFDataSource interface. Most of these are just delegated to
  // the inner, in-memory datasource.
  NS_IMETHOD GetURI(nsACString& aURI) override;

  NS_IMETHOD GetSource(nsIRDFResource* aProperty, nsIRDFNode* aTarget,
                       bool aTruthValue, nsIRDFResource** aSource) override {
    return mInner->GetSource(aProperty, aTarget, aTruthValue, aSource);
  }

  NS_IMETHOD GetSources(nsIRDFResource* aProperty, nsIRDFNode* aTarget,
                        bool aTruthValue,
                        nsISimpleEnumerator** aSources) override {
    return mInner->GetSources(aProperty, aTarget, aTruthValue, aSources);
  }

  NS_IMETHOD GetTarget(nsIRDFResource* aSource, nsIRDFResource* aProperty,
                       bool aTruthValue, nsIRDFNode** aTarget) override {
    return mInner->GetTarget(aSource, aProperty, aTruthValue, aTarget);
  }

  NS_IMETHOD GetTargets(nsIRDFResource* aSource, nsIRDFResource* aProperty,
                        bool aTruthValue,
                        nsISimpleEnumerator** aTargets) override {
    return mInner->GetTargets(aSource, aProperty, aTruthValue, aTargets);
  }

  NS_IMETHOD Assert(nsIRDFResource* aSource, nsIRDFResource* aProperty,
                    nsIRDFNode* aTarget, bool aTruthValue) override {
    return mInner->Assert(aSource, aProperty, aTarget, aTruthValue);
  }

  NS_IMETHOD Unassert(nsIRDFResource* aSource, nsIRDFResource* aProperty,
                      nsIRDFNode* aTarget) override {
    return mInner->Unassert(aSource, aProperty, aTarget);
  }

  NS_IMETHOD Change(nsIRDFResource* aSource, nsIRDFResource* aProperty,
                    nsIRDFNode* aOldTarget, nsIRDFNode* aNewTarget) override {
    return mInner->Change(aSource, aProperty, aOldTarget, aNewTarget);
  }

  NS_IMETHOD Move(nsIRDFResource* aOldSource, nsIRDFResource* aNewSource,
                  nsIRDFResource* aProperty, nsIRDFNode* aTarget) override {
    return mInner->Move(aOldSource, aNewSource, aProperty, aTarget);
  }

  NS_IMETHOD HasAssertion(nsIRDFResource* aSource, nsIRDFResource* aProperty,
                          nsIRDFNode* aTarget, bool aTruthValue,
                          bool* hasAssertion) override {
    return mInner->HasAssertion(aSource, aProperty, aTarget, aTruthValue,
                                hasAssertion);
  }

  NS_IMETHOD AddObserver(nsIRDFObserver* aObserver) override {
    return NS_ERROR_NOT_IMPLEMENTED;
  }

  NS_IMETHOD RemoveObserver(nsIRDFObserver* aObserver) override {
    return NS_ERROR_NOT_IMPLEMENTED;
  }

  NS_IMETHOD HasArcIn(nsIRDFNode* aNode, nsIRDFResource* aArc,
                      bool* _retval) override {
    return mInner->HasArcIn(aNode, aArc, _retval);
  }

  NS_IMETHOD HasArcOut(nsIRDFResource* aSource, nsIRDFResource* aArc,
                       bool* _retval) override {
    return mInner->HasArcOut(aSource, aArc, _retval);
  }

  NS_IMETHOD ArcLabelsIn(nsIRDFNode* aNode,
                         nsISimpleEnumerator** aLabels) override {
    return mInner->ArcLabelsIn(aNode, aLabels);
  }

  NS_IMETHOD ArcLabelsOut(nsIRDFResource* aSource,
                          nsISimpleEnumerator** aLabels) override {
    return mInner->ArcLabelsOut(aSource, aLabels);
  }

  NS_IMETHOD GetAllResources(nsISimpleEnumerator** aResult) override {
    return mInner->GetAllResources(aResult);
  }

  NS_IMETHOD GetAllCmds(
      nsIRDFResource* aSource,
      nsISimpleEnumerator /*<nsIRDFResource>*/** aCommands) override;

  NS_IMETHOD IsCommandEnabled(nsISupports* aSources, nsIRDFResource* aCommand,
                              nsISupports* aArguments, bool* aResult) override;

  NS_IMETHOD DoCommand(nsISupports* aSources, nsIRDFResource* aCommand,
                       nsISupports* aArguments) override;

  NS_IMETHOD BeginUpdateBatch() override { return mInner->BeginUpdateBatch(); }

  NS_IMETHOD EndUpdateBatch() override { return mInner->EndUpdateBatch(); }

  NS_IMETHOD GetLoaded(bool* _result) override;
  NS_IMETHOD Init(const char* uri) override;
  NS_IMETHOD Flush() override;
  NS_IMETHOD FlushTo(const char* aURI) override;
  NS_IMETHOD Refresh(bool sync) override;

  // nsIObserver
  NS_DECL_NSIOBSERVER
};

////////////////////////////////////////////////////////////////////////

LocalStoreImpl::LocalStoreImpl(void) {}

LocalStoreImpl::~LocalStoreImpl(void) {
  if (mRDFService) mRDFService->UnregisterDataSource(this);
}

nsresult NS_NewLocalStore(nsISupports* aOuter, REFNSIID aIID, void** aResult) {
  NS_PRECONDITION(aOuter == nullptr, "no aggregation");
  if (aOuter) return NS_ERROR_NO_AGGREGATION;

  NS_PRECONDITION(aResult != nullptr, "null ptr");
  if (!aResult) return NS_ERROR_NULL_POINTER;

  LocalStoreImpl* impl = new LocalStoreImpl();
  if (!impl) return NS_ERROR_OUT_OF_MEMORY;

  NS_ADDREF(impl);

  nsresult rv;
  rv = impl->Init();
  if (NS_SUCCEEDED(rv)) {
    // Set up the result pointer
    rv = impl->QueryInterface(aIID, aResult);
  }

  NS_RELEASE(impl);
  return rv;
}

NS_IMPL_CYCLE_COLLECTION(LocalStoreImpl, mInner)
NS_IMPL_CYCLE_COLLECTING_ADDREF(LocalStoreImpl)
NS_IMPL_CYCLE_COLLECTING_RELEASE(LocalStoreImpl)

NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(LocalStoreImpl)
  NS_INTERFACE_MAP_ENTRY(nsILocalStore)
  NS_INTERFACE_MAP_ENTRY(nsIRDFDataSource)
  NS_INTERFACE_MAP_ENTRY(nsIRDFRemoteDataSource)
  NS_INTERFACE_MAP_ENTRY(nsIObserver)
  NS_INTERFACE_MAP_ENTRY(nsISupportsWeakReference)
  NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsILocalStore)
NS_INTERFACE_MAP_END

// nsILocalStore interface

// nsIRDFDataSource interface

NS_IMETHODIMP
LocalStoreImpl::GetLoaded(bool* _result) {
  nsCOMPtr<nsIRDFRemoteDataSource> remote = do_QueryInterface(mInner);
  NS_ASSERTION(remote != nullptr, "not an nsIRDFRemoteDataSource");
  if (!remote) return NS_ERROR_UNEXPECTED;

  return remote->GetLoaded(_result);
}

NS_IMETHODIMP
LocalStoreImpl::Init(const char* uri) { return (NS_OK); }

NS_IMETHODIMP
LocalStoreImpl::Flush() {
  nsCOMPtr<nsIRDFRemoteDataSource> remote = do_QueryInterface(mInner);
  // FIXME Bug 340242: Temporarily make this a warning rather than an
  // assertion until we sort out the ordering of how we write
  // everything to the localstore, flush it, and disconnect it when
  // we're getting profile-change notifications.
  NS_WARNING_ASSERTION(remote != nullptr, "not an nsIRDFRemoteDataSource");
  if (!remote) return NS_ERROR_UNEXPECTED;

  return remote->Flush();
}

NS_IMETHODIMP
LocalStoreImpl::FlushTo(const char* aURI) {
  // Do not ever implement this (security)
  return NS_ERROR_NOT_IMPLEMENTED;
}

NS_IMETHODIMP
LocalStoreImpl::Refresh(bool sync) {
  nsCOMPtr<nsIRDFRemoteDataSource> remote = do_QueryInterface(mInner);
  NS_ASSERTION(remote != nullptr, "not an nsIRDFRemoteDataSource");
  if (!remote) return NS_ERROR_UNEXPECTED;

  return remote->Refresh(sync);
}

nsresult LocalStoreImpl::Init() {
  nsresult rv;

  rv = LoadData();
  if (NS_FAILED(rv)) return rv;

  // register this as a named data source with the RDF service
  mRDFService = do_GetService(NS_RDF_CONTRACTID "/rdf-service;1", &rv);
  if (NS_FAILED(rv)) return rv;

  mRDFService->RegisterDataSource(this, false);

  // Register as an observer of profile changes
  nsCOMPtr<nsIObserverService> obs =
      do_GetService("@mozilla.org/observer-service;1");

  if (obs) {
    obs->AddObserver(this, "profile-before-change", true);
    obs->AddObserver(this, "profile-do-change", true);
  }

  return NS_OK;
}

nsresult LocalStoreImpl::CreateLocalStore(nsIFile* aFile) {
  nsresult rv;

  rv = aFile->Create(nsIFile::NORMAL_FILE_TYPE, 0666);
  if (NS_FAILED(rv)) return rv;

  nsCOMPtr<nsIOutputStream> outStream;
  rv = NS_NewLocalFileOutputStream(getter_AddRefs(outStream), aFile);
  if (NS_FAILED(rv)) return rv;

  const char defaultRDF[] =
      "<?xml version=\"1.0\"?>\n"
      "<RDF:RDF xmlns:RDF=\"" RDF_NAMESPACE_URI
      "\"\n"
      "         xmlns:NC=\"" NC_NAMESPACE_URI
      "\">\n"
      "  <!-- Empty -->\n"
      "</RDF:RDF>\n";

  uint32_t count;
  rv = outStream->Write(defaultRDF, sizeof(defaultRDF) - 1, &count);
  if (NS_FAILED(rv)) return rv;

  if (count != sizeof(defaultRDF) - 1) return NS_ERROR_UNEXPECTED;

  // Okay, now see if the file exists _for real_. If it's still
  // not there, it could be that the profile service gave us
  // back a read-only directory. Whatever.
  bool fileExistsFlag = false;
  aFile->Exists(&fileExistsFlag);
  if (!fileExistsFlag) return NS_ERROR_UNEXPECTED;

  return NS_OK;
}

nsresult LocalStoreImpl::LoadData() {
  nsresult rv;

  // Look for localstore.rdf in the current profile
  // directory. Bomb if we can't find it.

  nsCOMPtr<nsIFile> aFile;
  rv = NS_GetSpecialDirectory(NS_APP_LOCALSTORE_50_FILE, getter_AddRefs(aFile));
  if (NS_FAILED(rv)) return rv;

  bool fileExistsFlag = false;
  (void)aFile->Exists(&fileExistsFlag);
  if (!fileExistsFlag) {
    // if file doesn't exist, create it
    rv = CreateLocalStore(aFile);
    if (NS_FAILED(rv)) return rv;
  }

  mInner = do_CreateInstance(
      NS_RDF_DATASOURCE_CONTRACTID_PREFIX "xml-datasource", &rv);
  if (NS_FAILED(rv)) return rv;

  nsCOMPtr<nsIRDFRemoteDataSource> remote = do_QueryInterface(mInner, &rv);
  if (NS_FAILED(rv)) return rv;

  nsCOMPtr<nsIURI> aURI;
  rv = NS_NewFileURI(getter_AddRefs(aURI), aFile);
  if (NS_FAILED(rv)) return rv;

  nsAutoCString spec;
  rv = aURI->GetSpec(spec);
  if (NS_FAILED(rv)) return rv;

  rv = remote->Init(spec.get());
  if (NS_FAILED(rv)) return rv;

  // Read the datasource synchronously.
  rv = remote->Refresh(true);

  if (NS_FAILED(rv)) {
    // Load failed, delete and recreate a fresh localstore
    aFile->Remove(true);
    rv = CreateLocalStore(aFile);
    if (NS_FAILED(rv)) return rv;

    rv = remote->Refresh(true);
  }

  return rv;
}

NS_IMETHODIMP
LocalStoreImpl::GetURI(nsACString& aURI) {
  aURI.AssignLiteral("rdf:local-store");
  return NS_OK;
}

NS_IMETHODIMP
LocalStoreImpl::GetAllCmds(
    nsIRDFResource* aSource,
    nsISimpleEnumerator /*<nsIRDFResource>*/** aCommands) {
  return (NS_NewEmptyEnumerator(aCommands));
}

NS_IMETHODIMP
LocalStoreImpl::IsCommandEnabled(nsISupports* aSources,
                                 nsIRDFResource* aCommand,
                                 nsISupports* aArguments, bool* aResult) {
  return NS_ERROR_NOT_IMPLEMENTED;
}

NS_IMETHODIMP
LocalStoreImpl::DoCommand(nsISupports* aSources, nsIRDFResource* aCommand,
                          nsISupports* aArguments) {
  return NS_ERROR_NOT_IMPLEMENTED;
}

NS_IMETHODIMP
LocalStoreImpl::Observe(nsISupports* aSubject, const char* aTopic,
                        const char16_t* someData) {
  nsresult rv = NS_OK;

  if (!nsCRT::strcmp(aTopic, "profile-before-change")) {
    // Write out the old datasource's contents.
    if (mInner) {
      nsCOMPtr<nsIRDFRemoteDataSource> remote = do_QueryInterface(mInner);
      if (remote) remote->Flush();
    }

    // Create an in-memory datasource for use while we're
    // profile-less.
    mInner = do_CreateInstance(NS_RDF_DATASOURCE_CONTRACTID_PREFIX
                               "in-memory-datasource");
  } else if (!nsCRT::strcmp(aTopic, "profile-do-change")) {
    rv = LoadData();
  }
  return rv;
}