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.

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 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 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */

#include "nsILDAPMessage.h"
#include "nsAbLDAPReplicationData.h"
#include "nsIAbCard.h"
#include "nsAbBaseCID.h"
#include "nsAbUtils.h"
#include "nsAbLDAPReplicationQuery.h"
#include "nsILDAPErrors.h"
#include "nsComponentManagerUtils.h"
#include "nsMsgUtils.h"

// once bug # 101252 gets fixed, this should be reverted back to be non
// threadsafe implementation is not really thread safe since each object should
// exist independently along with its related independent
// nsAbLDAPReplicationQuery object.
NS_IMPL_ISUPPORTS(nsAbLDAPProcessReplicationData,
                  nsIAbLDAPProcessReplicationData, nsILDAPMessageListener)

nsAbLDAPProcessReplicationData::nsAbLDAPProcessReplicationData()
    : nsAbLDAPListenerBase(),
      mState(kIdle),
      mProtocol(-1),
      mCount(0),
      mDBOpen(false),
      mInitialized(false) {}

nsAbLDAPProcessReplicationData::~nsAbLDAPProcessReplicationData() {
  /* destructor code */
  if (mDBOpen && mReplicationDB) mReplicationDB->Close(false);
}

NS_IMETHODIMP nsAbLDAPProcessReplicationData::Init(
    nsIAbLDAPDirectory *aDirectory, nsILDAPConnection *aConnection,
    nsILDAPURL *aURL, nsIAbLDAPReplicationQuery *aQuery,
    nsIWebProgressListener *aProgressListener) {
  NS_ENSURE_ARG_POINTER(aDirectory);
  NS_ENSURE_ARG_POINTER(aConnection);
  NS_ENSURE_ARG_POINTER(aURL);
  NS_ENSURE_ARG_POINTER(aQuery);

  mDirectory = aDirectory;
  mConnection = aConnection;
  mDirectoryUrl = aURL;
  mQuery = aQuery;

  mListener = aProgressListener;

  nsresult rv = mDirectory->GetAttributeMap(getter_AddRefs(mAttrMap));
  if (NS_FAILED(rv)) {
    mQuery = nullptr;
    return rv;
  }

  rv = mDirectory->GetAuthDn(mLogin);
  if (NS_FAILED(rv)) {
    mQuery = nullptr;
    return rv;
  }

  rv = mDirectory->GetSaslMechanism(mSaslMechanism);
  if (NS_FAILED(rv)) {
    mQuery = nullptr;
    return rv;
  }

  mInitialized = true;

  return rv;
}

NS_IMETHODIMP nsAbLDAPProcessReplicationData::GetReplicationState(
    int32_t *aReplicationState) {
  NS_ENSURE_ARG_POINTER(aReplicationState);
  *aReplicationState = mState;
  return NS_OK;
}

NS_IMETHODIMP nsAbLDAPProcessReplicationData::GetProtocolUsed(
    int32_t *aProtocolUsed) {
  NS_ENSURE_ARG_POINTER(aProtocolUsed);
  *aProtocolUsed = mProtocol;
  return NS_OK;
}

NS_IMETHODIMP nsAbLDAPProcessReplicationData::OnLDAPMessage(
    nsILDAPMessage *aMessage) {
  NS_ENSURE_ARG_POINTER(aMessage);

  if (!mInitialized) return NS_ERROR_NOT_INITIALIZED;

  int32_t messageType;
  nsresult rv = aMessage->GetType(&messageType);
  if (NS_FAILED(rv)) {
    Done(false);
    return rv;
  }

  switch (messageType) {
    case nsILDAPMessage::RES_BIND:
      rv = OnLDAPMessageBind(aMessage);
      if (NS_FAILED(rv)) rv = Abort();
      break;
    case nsILDAPMessage::RES_SEARCH_ENTRY:
      rv = OnLDAPSearchEntry(aMessage);
      break;
    case nsILDAPMessage::RES_SEARCH_RESULT:
      rv = OnLDAPSearchResult(aMessage);
      break;
    default:
      // for messageTypes we do not handle return NS_OK to LDAP and move ahead.
      rv = NS_OK;
      break;
  }

  return rv;
}

NS_IMETHODIMP nsAbLDAPProcessReplicationData::Abort() {
  if (!mInitialized) return NS_ERROR_NOT_INITIALIZED;

  nsresult rv = NS_OK;

  if (mState != kIdle && mOperation) {
    rv = mOperation->AbandonExt();
    if (NS_SUCCEEDED(rv)) mState = kIdle;
  }

  if (mReplicationDB && mDBOpen) {
    // force close since we need to delete the file.
    mReplicationDB->ForceClosed();
    mDBOpen = false;

    // delete the unsaved replication file
    if (mReplicationFile) {
      rv = mReplicationFile->Remove(false);
      if (NS_SUCCEEDED(rv) && mDirectory) {
        nsAutoCString fileName;
        rv = mDirectory->GetReplicationFileName(fileName);
        // now put back the backed up replicated file if aborted
        if (NS_SUCCEEDED(rv) && mBackupReplicationFile)
          rv = mBackupReplicationFile->MoveToNative(nullptr, fileName);
      }
    }
  }

  Done(false);

  return rv;
}

nsresult nsAbLDAPProcessReplicationData::DoTask() {
  if (!mInitialized) return NS_ERROR_NOT_INITIALIZED;

  nsresult rv = OpenABForReplicatedDir(true);
  if (NS_FAILED(rv))
    // do not call done here since it is called by OpenABForReplicationDir
    return rv;

  mOperation = do_CreateInstance(NS_LDAPOPERATION_CONTRACTID, &rv);
  NS_ENSURE_SUCCESS(rv, rv);

  rv = mOperation->Init(mConnection, this, nullptr);
  NS_ENSURE_SUCCESS(rv, rv);

  // get the relevant attributes associated with the directory server url
  nsAutoCString urlFilter;
  rv = mDirectoryUrl->GetFilter(urlFilter);
  if (NS_FAILED(rv)) return rv;

  nsAutoCString dn;
  rv = mDirectoryUrl->GetDn(dn);
  if (NS_FAILED(rv)) return rv;

  if (dn.IsEmpty()) return NS_ERROR_UNEXPECTED;

  int32_t scope;
  rv = mDirectoryUrl->GetScope(&scope);
  if (NS_FAILED(rv)) return rv;

  nsAutoCString attributes;
  rv = mDirectoryUrl->GetAttributes(attributes);
  if (NS_FAILED(rv)) return rv;

  mState = kReplicatingAll;

  if (mListener && NS_SUCCEEDED(rv))
    // XXX Cast from bool to nsresult
    mListener->OnStateChange(nullptr, nullptr,
                             nsIWebProgressListener::STATE_START,
                             static_cast<nsresult>(true));

  return mOperation->SearchExt(dn, scope, urlFilter, attributes, 0, 0);
}

void nsAbLDAPProcessReplicationData::InitFailed(bool aCancelled) {
  // Just call Done() which will ensure everything is tidied up nicely.
  Done(false);
}

nsresult nsAbLDAPProcessReplicationData::OnLDAPSearchEntry(
    nsILDAPMessage *aMessage) {
  NS_ENSURE_ARG_POINTER(aMessage);
  if (!mInitialized) return NS_ERROR_NOT_INITIALIZED;
  // since this runs on the main thread and is single threaded, this will
  // take care of entries returned by LDAP Connection thread after Abort.
  if (!mReplicationDB || !mDBOpen) return NS_ERROR_FAILURE;

  nsresult rv = NS_OK;

  // Although we would may naturally create an nsIAbLDAPCard here, we don't
  // need to as we are writing this straight to the database, so just create
  // the database version instead.
  nsCOMPtr<nsIAbCard> newCard(do_CreateInstance(NS_ABMDBCARD_CONTRACTID, &rv));
  if (NS_FAILED(rv)) {
    Abort();
    return rv;
  }

  rv = mAttrMap->SetCardPropertiesFromLDAPMessage(aMessage, newCard);
  if (NS_FAILED(rv)) {
    NS_WARNING(
        "nsAbLDAPProcessReplicationData::OnLDAPSearchEntry"
        "No card properties could be set");
    // if some entries are bogus for us, continue with next one
    return NS_OK;
  }

  rv = mReplicationDB->CreateNewCardAndAddToDB(newCard, false, nullptr);
  if (NS_FAILED(rv)) {
    Abort();
    return rv;
  }

  // now set the attribute for the DN of the entry in the card in the DB
  nsAutoCString authDN;
  rv = aMessage->GetDn(authDN);
  if (NS_SUCCEEDED(rv) && !authDN.IsEmpty()) {
    newCard->SetPropertyAsAUTF8String("_DN", authDN);
  }

  rv = mReplicationDB->EditCard(newCard, false, nullptr);
  if (NS_FAILED(rv)) {
    Abort();
    return rv;
  }

  mCount++;

  if (mListener && !(mCount % 10))  // inform the listener every 10 entries
  {
    mListener->OnProgressChange(nullptr, nullptr, mCount, -1, mCount, -1);
    // in case if the LDAP Connection thread is starved and causes problem
    // uncomment this one and try.
    // PR_Sleep(PR_INTERVAL_NO_WAIT); // give others a chance
  }

  return rv;
}

nsresult nsAbLDAPProcessReplicationData::OnLDAPSearchResult(
    nsILDAPMessage *aMessage) {
#ifdef DEBUG_rdayal
  printf("LDAP Replication : Got Results for Completion");
#endif

  NS_ENSURE_ARG_POINTER(aMessage);
  if (!mInitialized) return NS_ERROR_NOT_INITIALIZED;

  int32_t errorCode;
  nsresult rv = aMessage->GetErrorCode(&errorCode);

  if (NS_SUCCEEDED(rv)) {
    // We are done with the LDAP search for all entries.
    if (errorCode == nsILDAPErrors::SUCCESS ||
        errorCode == nsILDAPErrors::SIZELIMIT_EXCEEDED) {
      Done(true);
      if (mReplicationDB && mDBOpen) {
        rv = mReplicationDB->Close(true);
        NS_ASSERTION(NS_SUCCEEDED(rv),
                     "Replication DB Close on Success failed");
        mDBOpen = false;
        // once we have saved the new replication file, delete the backup file
        if (mBackupReplicationFile) {
          rv = mBackupReplicationFile->Remove(false);
          NS_ASSERTION(NS_SUCCEEDED(rv),
                       "Replication BackupFile Remove on Success failed");
        }
      }
      return NS_OK;
    }
  }

  // in case if GetErrorCode returned error or errorCode is not SUCCESS /
  // SIZELIMIT_EXCEEDED
  if (mReplicationDB && mDBOpen) {
    // if error result is returned close the DB without saving ???
    // should we commit anyway ??? whatever is returned is not lost then !!
    rv = mReplicationDB
             ->ForceClosed();  // force close since we need to delete the file.
    NS_ASSERTION(NS_SUCCEEDED(rv),
                 "Replication DB ForceClosed on Failure failed");
    mDBOpen = false;
    // if error result is returned remove the replicated file
    if (mReplicationFile) {
      rv = mReplicationFile->Remove(false);
      NS_ASSERTION(NS_SUCCEEDED(rv),
                   "Replication File Remove on Failure failed");
      if (NS_SUCCEEDED(rv)) {
        // now put back the backed up replicated file
        if (mBackupReplicationFile && mDirectory) {
          nsAutoCString fileName;
          rv = mDirectory->GetReplicationFileName(fileName);
          if (NS_SUCCEEDED(rv) && !fileName.IsEmpty()) {
            rv = mBackupReplicationFile->MoveToNative(nullptr, fileName);
            NS_ASSERTION(NS_SUCCEEDED(rv),
                         "Replication Backup File Move back on Failure failed");
          }
        }
      }
    }
    Done(false);
  }

  return NS_OK;
}

nsresult nsAbLDAPProcessReplicationData::OpenABForReplicatedDir(bool aCreate) {
  if (!mInitialized) return NS_ERROR_NOT_INITIALIZED;

  nsresult rv =
      mDirectory->GetReplicationFile(getter_AddRefs(mReplicationFile));
  if (NS_FAILED(rv)) {
    Done(false);
    return NS_ERROR_FAILURE;
  }

  nsCString fileName;
  rv = mReplicationFile->GetNativeLeafName(fileName);
  if (NS_FAILED(rv)) {
    Done(false);
    return rv;
  }

  // if the AB DB already exists backup existing one,
  // in case if the user cancels or Abort put back the backed up file
  bool fileExists;
  rv = mReplicationFile->Exists(&fileExists);
  if (NS_SUCCEEDED(rv) && fileExists) {
    // create the backup file object same as the Replication file object.
    // we create a backup file here since we need to cleanup the existing file
    // for create and then commit so instead of deleting existing cards we just
    // clone the existing one for a much better performance - for Download All.
    // And also important in case if replication fails we donot lose user's
    // existing replicated data for both Download all and Changelog.
    nsCOMPtr<nsIFile> clone;
    rv = mReplicationFile->Clone(getter_AddRefs(clone));
    if (NS_FAILED(rv)) {
      Done(false);
      return rv;
    }
    mBackupReplicationFile = clone;
    rv = mBackupReplicationFile->CreateUnique(nsIFile::NORMAL_FILE_TYPE, 0777);
    if (NS_FAILED(rv)) {
      Done(false);
      return rv;
    }
    nsAutoString backupFileLeafName;
    rv = mBackupReplicationFile->GetLeafName(backupFileLeafName);
    if (NS_FAILED(rv)) {
      Done(false);
      return rv;
    }
    // remove the newly created unique backup file so that move and copy
    // succeeds.
    rv = mBackupReplicationFile->Remove(false);
    if (NS_FAILED(rv)) {
      Done(false);
      return rv;
    }

    if (aCreate) {
      // set backup file to existing replication file for move
      mBackupReplicationFile->SetNativeLeafName(fileName);

      rv = mBackupReplicationFile->MoveTo(nullptr, backupFileLeafName);
      // set the backup file leaf name now
      if (NS_SUCCEEDED(rv))
        mBackupReplicationFile->SetLeafName(backupFileLeafName);
    } else {
      // set backup file to existing replication file for copy
      mBackupReplicationFile->SetNativeLeafName(fileName);

      // specify the parent here specifically,
      // passing nullptr to copy to the same dir actually renames existing file
      // instead of making another copy of the existing file.
      nsCOMPtr<nsIFile> parent;
      rv = mBackupReplicationFile->GetParent(getter_AddRefs(parent));
      if (NS_SUCCEEDED(rv))
        rv = mBackupReplicationFile->CopyTo(parent, backupFileLeafName);
      // set the backup file leaf name now
      if (NS_SUCCEEDED(rv))
        mBackupReplicationFile->SetLeafName(backupFileLeafName);
    }
    if (NS_FAILED(rv)) {
      Done(false);
      return rv;
    }
  }

  nsCOMPtr<nsIAddrDatabase> addrDBFactory =
      do_GetService(NS_ADDRDATABASE_CONTRACTID, &rv);
  if (NS_FAILED(rv)) {
    if (mBackupReplicationFile) mBackupReplicationFile->Remove(false);
    Done(false);
    return rv;
  }

  rv = addrDBFactory->Open(mReplicationFile, aCreate, true,
                           getter_AddRefs(mReplicationDB));
  if (NS_FAILED(rv)) {
    Done(false);
    if (mBackupReplicationFile) mBackupReplicationFile->Remove(false);
    return rv;
  }

  mDBOpen = true;  // replication DB is now Open
  return rv;
}

void nsAbLDAPProcessReplicationData::Done(bool aSuccess) {
  if (!mInitialized) return;

  mState = kReplicationDone;

  if (mQuery) mQuery->Done(aSuccess);

  if (mListener)
    // XXX Cast from bool to nsresult
    mListener->OnStateChange(nullptr, nullptr,
                             nsIWebProgressListener::STATE_STOP,
                             static_cast<nsresult>(aSuccess));

  // since this is called when all is done here, either on success,
  // failure or abort release the query now.
  mQuery = nullptr;
}

nsresult nsAbLDAPProcessReplicationData::DeleteCard(nsString &aDn) {
  nsCOMPtr<nsIAbCard> cardToDelete;
  mReplicationDB->GetCardFromAttribute(nullptr, "_DN",
                                       NS_ConvertUTF16toUTF8(aDn), false,
                                       getter_AddRefs(cardToDelete));
  return mReplicationDB->DeleteCard(cardToDelete, false, nullptr);
}