Source/WebCore/contentextensions/ContentRuleListResults.h

/*
 * Copyright (C) 2019 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#if ENABLE(CONTENT_EXTENSIONS)

#include "ContentExtensionActions.h"
#include <wtf/KeyValuePair.h>
#include <wtf/Vector.h>
#include <wtf/text/WTFString.h>

namespace WebCore {
    
struct ContentRuleListResults {
    struct Result {
        bool blockedLoad { false };
        bool madeHTTPS { false };
        bool blockedCookies { false };
        bool modifiedHeaders { false };
        bool redirected { false };
        Vector<String> notifications;
        
        bool shouldNotifyApplication() const
        {
            return blockedLoad
                || madeHTTPS
                || blockedCookies
                || modifiedHeaders
                || redirected
                || !notifications.isEmpty();
        }

        template<class Encoder> void encode(Encoder&) const;
        template<class Decoder> static std::optional<Result> decode(Decoder&);
    };
    struct Summary {
        bool blockedLoad { false };
        bool madeHTTPS { false };
        bool blockedCookies { false };
        bool hasNotifications { false };
        Vector<ContentExtensions::ModifyHeadersAction> modifyHeadersActions;
        Vector<std::pair<ContentExtensions::RedirectAction, URL>> redirectActions;

        template<class Encoder> void encode(Encoder&) const;
        template<class Decoder> static std::optional<Summary> decode(Decoder&);
    };
    using ContentRuleListIdentifier = String;

    Summary summary;
    Vector<std::pair<ContentRuleListIdentifier, Result>> results;
    
    bool shouldNotifyApplication() const
    {
        return summary.blockedLoad
            || summary.madeHTTPS
            || summary.blockedCookies
            || !summary.modifyHeadersActions.isEmpty()
            || !summary.redirectActions.isEmpty()
            || summary.hasNotifications;
    }
    
    template<class Encoder> void encode(Encoder& encoder) const
    {
        encoder << summary;
        encoder << results;
    }
    template<class Decoder> static std::optional<ContentRuleListResults> decode(Decoder& decoder)
    {
        std::optional<Summary> summary;
        decoder >> summary;
        if (!summary)
            return std::nullopt;
        
        std::optional<Vector<std::pair<ContentRuleListIdentifier, Result>>> results;
        decoder >> results;
        if (!results)
            return std::nullopt;
        
        return {{
            WTFMove(*summary),
            WTFMove(*results)
        }};
    }
};

template<class Encoder> void ContentRuleListResults::Result::encode(Encoder& encoder) const
{
    encoder << blockedLoad;
    encoder << madeHTTPS;
    encoder << blockedCookies;
    encoder << modifiedHeaders;
    encoder << redirected;
    encoder << notifications;
}

template<class Decoder> auto ContentRuleListResults::Result::decode(Decoder& decoder) -> std::optional<Result>
{
    std::optional<bool> blockedLoad;
    decoder >> blockedLoad;
    if (!blockedLoad)
        return std::nullopt;
    
    std::optional<bool> madeHTTPS;
    decoder >> madeHTTPS;
    if (!madeHTTPS)
        return std::nullopt;
    
    std::optional<bool> blockedCookies;
    decoder >> blockedCookies;
    if (!blockedCookies)
        return std::nullopt;
    
    std::optional<bool> modifiedHeaders;
    decoder >> modifiedHeaders;
    if (!modifiedHeaders)
        return std::nullopt;
    
    std::optional<bool> redirected;
    decoder >> redirected;
    if (!redirected)
        return std::nullopt;
    
    std::optional<Vector<String>> notifications;
    decoder >> notifications;
    if (!notifications)
        return std::nullopt;

    return {{
        WTFMove(*blockedLoad),
        WTFMove(*madeHTTPS),
        WTFMove(*blockedCookies),
        WTFMove(*modifiedHeaders),
        WTFMove(*redirected),
        WTFMove(*notifications)
    }};
}

template<class Encoder> void ContentRuleListResults::Summary::encode(Encoder& encoder) const
{
    encoder << blockedLoad;
    encoder << madeHTTPS;
    encoder << blockedCookies;
    encoder << hasNotifications;
}

template<class Decoder> auto ContentRuleListResults::Summary::decode(Decoder& decoder) -> std::optional<Summary>
{
    std::optional<bool> blockedLoad;
    decoder >> blockedLoad;
    if (!blockedLoad)
        return std::nullopt;
    
    std::optional<bool> madeHTTPS;
    decoder >> madeHTTPS;
    if (!madeHTTPS)
        return std::nullopt;
    
    std::optional<bool> blockedCookies;
    decoder >> blockedCookies;
    if (!blockedCookies)
        return std::nullopt;
    
    std::optional<bool> hasNotifications;
    decoder >> hasNotifications;
    if (!hasNotifications)
        return std::nullopt;
    
    return {{
        WTFMove(*blockedLoad),
        WTFMove(*madeHTTPS),
        WTFMove(*blockedCookies),
        WTFMove(*hasNotifications),
        { }, // modifyHeadersActions and redirectActions have no need to be serialized to another process.
        { }
    }};
}

}

#endif // ENABLE(CONTENT_EXTENSIONS)