privet_http.h revision 7dbb3d5cf0c15f500944d211057644d6a2f37371
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright 2013 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_LOCAL_DISCOVERY_PRIVET_HTTP_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_LOCAL_DISCOVERY_PRIVET_HTTP_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 107d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)#include "base/callback.h" 11ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#include "chrome/browser/local_discovery/privet_url_fetcher.h" 125d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "net/base/host_port_pair.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace local_discovery { 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PrivetHTTPImpl; 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Represents a request to /privet/info. Will store a cached response and token 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the PrivetHTTPClient that created. 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PrivetInfoOperation { 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class Delegate { 235d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) public: 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~Delegate() {} 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In case of non-HTTP errors, |http_code| will be -1. 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnPrivetInfoDone(int http_code, 28eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const base::DictionaryValue* json_value) = 0; 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~PrivetInfoOperation() {} 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Start() = 0; 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Represents a full registration flow (/privet/register), normally consisting 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// of calling the start action, the getClaimToken action, and calling the 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// complete action. Some intervention from the caller is required to display the 39eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch// claim URL to the user (noted in OnPrivetRegisterClaimURL). 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PrivetRegisterOperation { 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum FailureReason { 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FAILURE_NETWORK, 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FAILURE_HTTP_ERROR, 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FAILURE_JSON_ERROR, 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FAILURE_MALFORMED_RESPONSE 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class Delegate { 50eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch public: 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~Delegate() {} 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a user needs to claim the printer by visiting the given URL. 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnPrivetRegisterClaimToken(const std::string& token, 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& url) = 0; 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called in case of an error while registering. |action| is the 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // registration action taken during the error. |reason| is the reason for 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the failure. |printer_http_code| is the http code returned from the 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // printer. If it is -1, an internal error occurred while trying to complete 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the request. |json| may be null if printer_http_code signifies an error. 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnPrivetRegisterError(const std::string& action, 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FailureReason reason, 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int printer_http_code, 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DictionaryValue* json) = 0; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when the registration is done. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnPrivetRegisterDone(const std::string& device_id) = 0; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~PrivetRegisterOperation() {} 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Start() = 0; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Owner SHOULD call explicitly before destroying operation. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Cancel() = 0; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CompleteRegistration() = 0; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Privet HTTP client. Must not outlive the operations it creates. 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PrivetHTTPClient { 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~PrivetHTTPClient() {} 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual const base::DictionaryValue* GetCachedInfo() const = 0; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual scoped_ptr<PrivetRegisterOperation> CreateRegisterOperation( 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& user, 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PrivetRegisterOperation::Delegate* delegate) = 0; 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual scoped_ptr<PrivetInfoOperation> CreateInfoOperation( 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PrivetInfoOperation::Delegate* delegate) = 0; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace local_discovery 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_LOCAL_DISCOVERY_PRIVET_HTTP_H_ 945d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)