libreoffice/connectivity/source/drivers/macab/MacabAddressBook.cxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * 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/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */


#include "MacabAddressBook.hxx"
#include "MacabRecords.hxx"
#include "MacabGroup.hxx"

#include <vector>

#include <premac.h>
#include <Carbon/Carbon.h>
#include <AddressBook/ABAddressBookC.h>
#include <postmac.h>
#include <connectivity/CommonTools.hxx>

using namespace connectivity::macab;
using namespace ::com::sun::star::uno;

namespace {

void manageDuplicateGroups(std::vector<MacabGroup *> _xGroups)
{
    /* If we have two cases of groups, say, family, this makes it:
     * family
     * family (2)
     */
    std::vector<MacabGroup *>::reverse_iterator iter1, iter2;
    sal_Int32 count;

    for(iter1 = _xGroups.rbegin(); iter1 != _xGroups.rend(); ++iter1)
    {
        /* If the name matches the default table name, there is already
         * (obviously) a conflict. So, start the count of groups with this
         * name at 2 instead of 1.
         */
        if( (*iter1)->getName() == MacabAddressBook::getDefaultTableName() )
            count = 2;
        else
            count = 1;

        iter2 = iter1;
        for( ++iter2; iter2 != _xGroups.rend(); ++iter2)
        {
            if( (*iter1)->getName() == (*iter2)->getName() )
            {
                count++;
            }
        }

        // duplicate!
        if(count != 1)
        {
            OUString sName = (*iter1)->getName() + " (" +
                OUString::number(count) +
                ")";
            (*iter1)->setName(sName);
        }
    }
}

}

MacabAddressBook::MacabAddressBook( )
 : m_aAddressBook(ABGetSharedAddressBook()),
   m_xMacabRecords(nullptr),
   m_bRetrievedGroups(false)
{
    if(m_aAddressBook == nullptr)
    {
        // TODO: tell the user to reset the permission via "tccutil reset AddressBook"
        // or the system preferences and try again, this time granting the access
        throw RuntimeException(
            "failed to access the macOS address book - permission not granted?" );
    }
}


MacabAddressBook::~MacabAddressBook()
{
    if(m_xMacabRecords != nullptr)
    {
        delete m_xMacabRecords;
        m_xMacabRecords = nullptr;
    }

    for(MacabGroup* pMacabGroup : m_xMacabGroups)
        delete pMacabGroup;

    m_bRetrievedGroups = false;
}


/* Get the address book's default table name. This is the table name that
 * refers to the table containing _all_ records in the address book.
 */
const OUString & MacabAddressBook::getDefaultTableName()
{
    /* This string probably needs to be localized. */
    static constexpr OUString aDefaultTableName
        (u"Address Book"_ustr);

    return aDefaultTableName;
}


MacabRecords *MacabAddressBook::getMacabRecords()
{
    /* If the MacabRecords don't exist, create them. */
    if(m_xMacabRecords == nullptr)
    {
        m_xMacabRecords = new MacabRecords(m_aAddressBook);
        m_xMacabRecords->setName(getDefaultTableName());
        m_xMacabRecords->initialize();
    }

    return m_xMacabRecords;
}


/* Get the MacabRecords for a given name: either a group name or the
 * default table name.
 */
MacabRecords *MacabAddressBook::getMacabRecords(std::u16string_view _tableName)
{
    if(_tableName == getDefaultTableName())
    {
        return getMacabRecords();
    }
    else
    {
        return getMacabGroup(_tableName);
    }
}


MacabRecords *MacabAddressBook::getMacabRecordsMatch(const OUString& _tableName)
{
    if(match(_tableName, getDefaultTableName(), '\0'))
    {
        return getMacabRecords();
    }

    return getMacabGroupMatch(_tableName);
}


std::vector<MacabGroup *> MacabAddressBook::getMacabGroups()
{
    /* If the MacabGroups haven't been created yet, create them. */
    if(!m_bRetrievedGroups)
    {
        /* If the MacabRecords haven't been created yet, create them. */
        if(m_xMacabRecords == nullptr)
        {
            m_xMacabRecords = new MacabRecords(m_aAddressBook);
            m_xMacabRecords->setName(getDefaultTableName());
            m_xMacabRecords->initialize();
        }

        CFArrayRef allGroups = ABCopyArrayOfAllGroups(m_aAddressBook);
        sal_Int32 nGroups = CFArrayGetCount(allGroups);
        m_xMacabGroups = std::vector<MacabGroup *>(nGroups);

        sal_Int32 i;
        ABGroupRef xGroup;

        /* Go through each group and create a MacabGroup out of it. */
        for(i = 0; i < nGroups; i++)
        {
            xGroup = static_cast<ABGroupRef>(const_cast<void *>(CFArrayGetValueAtIndex(allGroups, i)));
            m_xMacabGroups[i] = new MacabGroup(m_aAddressBook, m_xMacabRecords, xGroup);
        }

        CFRelease(allGroups);

        /* Manage duplicates. */
        manageDuplicateGroups(m_xMacabGroups);
        m_bRetrievedGroups = true;
    }

    return m_xMacabGroups;
}


MacabGroup *MacabAddressBook::getMacabGroup(std::u16string_view _groupName)
{
    // initialize groups if not already initialized
    if(!m_bRetrievedGroups)
        getMacabGroups();

    sal_Int32 nGroups = m_xMacabGroups.size();
    sal_Int32 i;

    for(i = 0; i < nGroups; i++)
    {
        if(m_xMacabGroups[i] != nullptr)
        {
            if(m_xMacabGroups[i]->getName() == _groupName)
            {
                return m_xMacabGroups[i];
            }
        }
    }

    return nullptr;
}


MacabGroup *MacabAddressBook::getMacabGroupMatch(OUString const & _groupName)
{
    // initialize groups if not already initialized
    if(!m_bRetrievedGroups)
        getMacabGroups();

    sal_Int32 nGroups = m_xMacabGroups.size();
    sal_Int32 i;

    for(i = 0; i < nGroups; i++)
    {
        if(m_xMacabGroups[i] != nullptr)
        {
            if(match(m_xMacabGroups[i]->getName(), _groupName, '\0'))
            {
                return m_xMacabGroups[i];
            }
        }
    }

    return nullptr;
}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */