/**
 * @file lltransactionflags.cpp
 * @brief Some exported symbols and functions for dealing with
 * transaction flags.
 *
 * $LicenseInfo:firstyear=2003&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#include "linden_common.h"

#include "lluuid.h"
#include "lltransactionflags.h"
#include "lltransactiontypes.h"

const U8 TRANSACTION_FLAGS_NONE = 0;
const U8 TRANSACTION_FLAG_SOURCE_GROUP = 1;
const U8 TRANSACTION_FLAG_DEST_GROUP = 2;
const U8 TRANSACTION_FLAG_OWNER_GROUP = 4;
const U8 TRANSACTION_FLAG_SIMULTANEOUS_CONTRIBUTION = 8;
const U8 TRANSACTION_FLAG_SIMULTANEOUS_CONTRIBUTION_REMOVAL = 16;

U8 pack_transaction_flags(bool is_source_group, bool is_dest_group)
{
    U8 rv = 0;
    if(is_source_group) rv |= TRANSACTION_FLAG_SOURCE_GROUP;
    if(is_dest_group) rv |= TRANSACTION_FLAG_DEST_GROUP;
    return rv;
}

bool is_tf_source_group(TransactionFlags flags)
{
    return ((flags & TRANSACTION_FLAG_SOURCE_GROUP) == TRANSACTION_FLAG_SOURCE_GROUP);
}

bool is_tf_dest_group(TransactionFlags flags)
{
    return ((flags & TRANSACTION_FLAG_DEST_GROUP) == TRANSACTION_FLAG_DEST_GROUP);
}

bool is_tf_owner_group(TransactionFlags flags)
{
    return ((flags & TRANSACTION_FLAG_OWNER_GROUP) == TRANSACTION_FLAG_OWNER_GROUP);
}

void append_reason(
    std::ostream& ostr,
    S32 transaction_type,
    const std::string& description)
{
    switch( transaction_type )
    {
    case TRANS_OBJECT_SALE:
      ostr << " for " << (description.length() > 0 ? description : std::string("<unknown>"));
        break;
    case TRANS_LAND_SALE:
        ostr << " for a parcel of land";
        break;
    case TRANS_LAND_PASS_SALE:
        ostr << " for a land access pass";
        break;
    case TRANS_GROUP_LAND_DEED:
        ostr << " for deeding land";
        break;
    default:
        break;
    }
}

std::string build_transfer_message_to_source(
    S32 amount,
    const LLUUID& source_id,
    const LLUUID& dest_id,
    const std::string& dest_name,
    S32 transaction_type,
    const std::string& description)
{
    LL_DEBUGS() << "build_transfer_message_to_source: " << amount << " "
        << source_id << " " << dest_id << " " << dest_name << " "
        << transaction_type << " "
        << (description.empty() ? "(no desc)" : description)
        << LL_ENDL;
    if(source_id.isNull())
    {
        return description;
    }
    if((0 == amount) && description.empty())
    {
        return description;
    }
    std::ostringstream ostr;
    if(dest_id.isNull())
    {
        // *NOTE: Do not change these strings!  The viewer matches
        // them in llviewermessage.cpp to perform localization.
        // If you need to make changes, add a new, localizable message. JC
        ostr << "You paid L$" << amount;
        switch(transaction_type)
        {
        case TRANS_GROUP_CREATE:
            ostr << " to create a group";
            break;
        case TRANS_GROUP_JOIN:
            ostr << " to join a group";
            break;
        case TRANS_UPLOAD_CHARGE:
            ostr << " to upload";
            break;
        default:
            break;
        }
    }
    else
    {
        ostr << "You paid " << dest_name << " L$" << amount;
        append_reason(ostr, transaction_type, description);
    }
    ostr << ".";
    return ostr.str();
}

std::string build_transfer_message_to_destination(
    S32 amount,
    const LLUUID& dest_id,
    const LLUUID& source_id,
    const std::string& source_name,
    S32 transaction_type,
    const std::string& description)
{
    LL_DEBUGS() << "build_transfer_message_to_dest: " << amount << " "
        << dest_id << " " << source_id << " " << source_name << " "
        << transaction_type << " " << (description.empty() ? "(no desc)" : description)
        << LL_ENDL;
    if(0 == amount)
    {
        return std::string();
    }
    if(dest_id.isNull())
    {
        return description;
    }
    std::ostringstream ostr;
    // *NOTE: Do not change these strings!  The viewer matches
    // them in llviewermessage.cpp to perform localization.
    // If you need to make changes, add a new, localizable message. JC
    ostr << source_name << " paid you L$" << amount;
    append_reason(ostr, transaction_type, description);
    ostr << ".";
    return ostr.str();
}