chrome/installer/mac/app/downloader.h - Issue 2094583004: Initial commit for Chrome metainstaller on Mac.

Side by Side Diff: chrome/installer/mac/app/downloader.h

Issue 2094583004: Initial commit for Chrome metainstaller on Mac. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: Additional progress addressing downloader and parser, moved BUILD dependencies away from root. Created 4 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch

OLD	NEW
(Empty)
	1 // Copyright (c) 2016 The Chromium Authors. All rights reserved.
	Mark Mentovai 2016/06/28 15:42:50 Minor nit: we don’t put the “(c)” in anymore. Minor nit: we don’t put the “(c)” in anymore.
	2 // Use of this source code is governed by a BSD-style license that can be

	3 // found in the LICENSE file.

	4

	5 #ifndef CHROME_INSTALLER_MAC_APP_DOWNLOADER_H_

	6 #define CHROME_INSTALLER_MAC_APP_DOWNLOADER_H_

	7

	8 #import <Foundation/Foundation.h>

	9

	10 @interface Downloader : NSObject <NSXMLParserDelegate>

	11 @property(nonatomic, copy) NSMutableArray *chromeDownloadURLs;
	Mark Mentovai 2016/06/28 15:42:50 Nit: Chrome style is to put the * on the type name Nit: Chrome style is to put the * on the type name, not the variable. This is actually what you’ve done elsewhere, like in “(void)parseXML:(NSData*)omahaResponseXML” below.
	12 @property(nonatomic, copy) NSString *chromeImageFilename;

	13

	14 // Prepares the array for use in the following methods.
	Mark Mentovai 2016/06/28 15:42:50 A comment isn’t normally needed for -init methods, A comment isn’t normally needed for -init methods, especially when they don’t take any arguments. It’s an Objective-C convention that an object isn’t usable until an -init method has been called.
	15 - (id)init;

	16

	17 // Will parse the XML passed into it and extract all the url's it finds as well
	Mark Mentovai 2016/06/28 15:42:50 Comments should be written more directly. Instead Comments should be written more directly. Instead of “will x, then will y”, you can just say “X and Y.” It’s easier and faster to read if it says “Parses omahaResponseXML and extracts …, then adds …” Mark Mentovai 2016/06/28 15:42:50 URLs, not url's. Elsewhere, too. URLs, not url's. Elsewhere, too.
	18 // as the filename. Will then add each url into the array of url's and report
	Mark Mentovai 2016/06/28 15:42:50 How does it report errors? It has a void return va How does it report errors? It has a void return value, so this isn’t obvious.
	19 // any errors it had.

	20 - (void)parseXML:(NSData*)omahaResponseXML;

	21

	22 // The URL's we got from the previous method are incomplete and need the
	Mark Mentovai 2016/06/28 15:42:50 go/avoidwe go/avoidwe
	23 // filename (which is the same for all the links) appended to the end.

	24 // This method iterates through the array and appends the filename to each URL.

	25 - (void)appendFilenameToURL;
	Mark Mentovai 2016/06/28 15:42:50 Not sure this makes sense to expose from this clas Not sure this makes sense to expose from this class. Usually, when you see that a method is only used in the .mm file but isn’t called by anyone else, it makes sense to take it out of the header. One option is to stick it into a private category in the .mm file to hide it from the rest of the world.
	26

	27 // Expects the NSData object passed in to be an Omaha XML response file
	Mark Mentovai 2016/06/28 15:42:50 Start with a description of what this method does, Start with a description of what this method does, and then deal with parameters and expectations. Like: “Calls the XML parser, extracts URLs, and returns the first one. chromeImageAsData is the XML response from Omaha.” You can just call it “XML” or an “XML response.” Saying “file” makes it sound like it’s been written to disk somewhere, but we’ve just got the XML in memory.
	28 // Will then call the XML parser and extract the four URL's to the current
	Mark Mentovai 2016/06/28 15:42:50 Why four? It might not always be four. Why four? It might not always be four.
	29 // version of Chrome and return the first entry in that array

	30 // TODO(ivan): check the URL's actually work ie. response is a 200/202 and

	31 // return the first working URL.

	32 - (NSURL)getChromeImageURL: (NSData)chromeImageAsData;
	Mark Mentovai 2016/06/28 15:42:50 Style nit: no space after the colon. Do it like yo Style nit: no space after the colon. Do it like you did with -parseXML. Mark Mentovai 2016/06/28 15:42:50 but I think that chromeImageAsData is a misleading but I think that chromeImageAsData is a misleading name here.
	33

	34 // Takes the URL from getChromeImageURL and packages it into a NSData for easier
	Mark Mentovai 2016/06/28 15:42:50 Not sure what this does. Not sure what this does.
	35 // downloading.

	36 - (NSData)downloadChromeAsData: (NSURL)chromeURL;

	37

	38 // Returns a path to an individuals home download folder.
	Mark Mentovai 2016/06/28 15:42:50 an individuals→the user’s an individuals→the user’s
	39 - (NSString*)getDownloadsFilePath;

	40

	41 // Uses the packaged data from before as well as the filepath from before to
	Mark Mentovai 2016/06/28 15:42:50 “before” = when? “before” = when?
	42 // download the chrome install image to the downloads folder.

	43 - (void)writeChromeImageToDownloadsDirectory: (NSData*)chromeImageAsData;

	44

	45 - (void)downloadChromeImageToDownloadsDirectory: (NSData*)responseXMLData;
	Mark Mentovai 2016/06/28 15:42:50 What’s this do? What’s this do?
	46

	47 @end

	48

	49 #endif // CHROME_INSTALLER_MAC_APP_DOWNLOADER_H_

OLD	NEW

« chrome/installer/mac/app/BUILD.gn ('K') | « chrome/installer/mac/app/OWNERS ('k') | chrome/installer/mac/app/downloader.m » ('j') | chrome/installer/mac/app/downloader.m » ('J')