15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 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) 57dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#ifndef CHROME_UTILITY_EXTENSIONS_UNPACKER_H_ 67dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#define CHROME_UTILITY_EXTENSIONS_UNPACKER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/files/file_path.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 133551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)#include "extensions/common/manifest.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SkBitmap; 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class DictionaryValue; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace extensions { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class unpacks an extension. It is designed to be used in a sandboxed 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// child process. We unpack and parse various bits of the extension, then 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// report back to the browser process, who then transcodes the pre-parsed bits 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and writes them back out to disk for later use. 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Unpacker { 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) Unpacker(const base::FilePath& extension_path, 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& extension_id, 312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) Manifest::Location location, 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int creation_flags); 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~Unpacker(); 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Install the extension file at |extension_path|. Returns true on success. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Otherwise, error_message will contain a string explaining what went wrong. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Run(); 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Write the decoded images to kDecodedImagesFilename. We do this instead 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of sending them over IPC, since they are so large. Returns true on 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // success. 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool DumpImagesToFile(); 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Write the decoded messages to kDecodedMessageCatalogsFilename. We do this 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // instead of sending them over IPC, since they are so large. Returns true on 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // success. 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool DumpMessageCatalogsToFile(); 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const base::string16& error_message() { return error_message_; } 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::DictionaryValue* parsed_manifest() { 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return parsed_manifest_.get(); 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::DictionaryValue* parsed_catalogs() { return parsed_catalogs_.get(); } 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Parse the manifest.json file inside the extension (not in the header). 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Caller takes ownership of return value. 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::DictionaryValue* ReadManifest(); 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Parse all _locales/*/messages.json files inside the extension. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ReadAllMessageCatalogs(const std::string& default_locale); 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Decodes the image at the given path and puts it in our list of decoded 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // images. 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool AddDecodedImage(const base::FilePath& path); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Parses the catalog at the given path and puts it in our list of parsed 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // catalogs. 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ReadMessageCatalog(const base::FilePath& message_path); 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Set the error message. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetError(const std::string& error); 735d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void SetUTF16Error(const base::string16& error); 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The extension to unpack. 762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) base::FilePath extension_path_; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The extension ID if known. 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string extension_id_; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The location to use for the created extension. 822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) Manifest::Location location_; 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The creation flags to use with the created extension. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int creation_flags_; 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The place we unpacked the extension to. 882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) base::FilePath temp_install_dir_; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The parsed version of the manifest JSON contained in the extension. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<base::DictionaryValue> parsed_manifest_; 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A list of decoded images and the paths where those images came from. Paths 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // are relative to the manifest file. 957dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch struct InternalData; 967dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch scoped_ptr<InternalData> internal_data_; 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Dictionary of relative paths and catalogs per path. Paths are in the form 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of _locales/locale, without messages.json base part. 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<base::DictionaryValue> parsed_catalogs_; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The last error message that was set. Empty if there were no errors. 1035d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) base::string16 error_message_; 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(Unpacker); 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace extensions 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1107dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#endif // CHROME_UTILITY_EXTENSIONS_UNPACKER_H_ 111