Constrain max size of link preview image.

pull/1/head
Matthew Chen 6 years ago
parent e35c6eaf69
commit 9b33d70d7b

@ -11,6 +11,7 @@
#import "UIColor+OWS.h" #import "UIColor+OWS.h"
#import "UIFont+OWS.h" #import "UIFont+OWS.h"
#import "ViewControllerUtils.h" #import "ViewControllerUtils.h"
#import <PromiseKit/AnyPromise.h>
#import <SignalMessaging/OWSFormat.h> #import <SignalMessaging/OWSFormat.h>
#import <SignalMessaging/SignalMessaging-Swift.h> #import <SignalMessaging/SignalMessaging-Swift.h>
#import <SignalMessaging/UIView+OWS.h> #import <SignalMessaging/UIView+OWS.h>
@ -739,27 +740,24 @@ const CGFloat kMaxTextViewHeight = 98;
[self ensureLinkPreviewViewWithState:[LinkPreviewLoading new]]; [self ensureLinkPreviewViewWithState:[LinkPreviewLoading new]];
__weak ConversationInputToolbar *weakSelf = self; __weak ConversationInputToolbar *weakSelf = self;
[OWSLinkPreview tryToBuildPreviewInfoWithPreviewUrl:previewUrl [[OWSLinkPreview tryToBuildPreviewInfoObjcWithPreviewUrl:previewUrl]
callbackQueue:dispatch_get_main_queue() .then(^(OWSLinkPreviewDraft *linkPreviewDraft) {
completion:^(OWSLinkPreviewDraft *_Nullable linkPreviewDraft) { ConversationInputToolbar *_Nullable strongSelf = weakSelf;
ConversationInputToolbar *_Nullable strongSelf = weakSelf; if (!strongSelf) {
if (!strongSelf) { return;
return; }
} if (strongSelf.inputLinkPreview != inputLinkPreview) {
if (strongSelf.inputLinkPreview != inputLinkPreview) { // Obsolete callback.
// Obsolete callback. return;
return; }
} inputLinkPreview.linkPreviewDraft = linkPreviewDraft;
if (!linkPreviewDraft) { LinkPreviewDraft *viewState = [[LinkPreviewDraft alloc] initWithLinkPreviewDraft:linkPreviewDraft];
// The link preview could not be loaded. [strongSelf ensureLinkPreviewViewWithState:viewState];
[strongSelf clearLinkPreviewView]; })
return; .catch(^(id error) {
} // The link preview could not be loaded.
inputLinkPreview.linkPreviewDraft = linkPreviewDraft; [weakSelf clearLinkPreviewView];
LinkPreviewDraft *viewState = [[LinkPreviewDraft alloc] }) retainUntilComplete];
initWithLinkPreviewDraft:linkPreviewDraft];
[strongSelf ensureLinkPreviewViewWithState:viewState];
}];
} }
- (void)ensureLinkPreviewViewWithState:(id<LinkPreviewState>)state - (void)ensureLinkPreviewViewWithState:(id<LinkPreviewState>)state

@ -3,11 +3,15 @@
// //
import Foundation import Foundation
import PromiseKit
@objc @objc
public enum LinkPreviewError: Int, Error { public enum LinkPreviewError: Int, Error {
case invalidInput case invalidInput
case noPreview case noPreview
case assertionFailure
case couldNotDownload
case featureDisabled
} }
// MARK: - OWSLinkPreviewDraft // MARK: - OWSLinkPreviewDraft
@ -424,70 +428,62 @@ public class OWSLinkPreview: MTLModel {
// This cache should only be accessed on serialQueue. // This cache should only be accessed on serialQueue.
private static var linkPreviewDraftCache: NSCache<AnyObject, OWSLinkPreviewDraft> = NSCache() private static var linkPreviewDraftCache: NSCache<AnyObject, OWSLinkPreviewDraft> = NSCache()
private class func cachedLinkPreview(forPreviewUrl previewUrl: String) -> OWSLinkPreviewDraft? {
var result: OWSLinkPreviewDraft?
serialQueue.sync {
result = linkPreviewDraftCache.object(forKey: previewUrl as AnyObject)
}
return result
}
private class func setCachedLinkPreview(_ linkPreviewDraft: OWSLinkPreviewDraft,
forPreviewUrl previewUrl: String) {
serialQueue.sync {
previewUrlCache.setObject(linkPreviewDraft, forKey: previewUrl as AnyObject)
}
}
@objc
public class func tryToBuildPreviewInfoObjc(previewUrl: String?) -> AnyPromise {
return AnyPromise(tryToBuildPreviewInfo(previewUrl: previewUrl))
}
// Completion will always be invoked exactly once. // Completion will always be invoked exactly once.
// //
// The completion is called with a link preview if one can be built for // The completion is called with a link preview if one can be built for
// the message body. It building the preview fails, completion will be // the message body. It building the preview fails, completion will be
// called with nil to avoid failing the message send. // called with nil to avoid failing the message send.
@objc public class func tryToBuildPreviewInfo(previewUrl: String?) -> Promise<OWSLinkPreviewDraft> {
public class func tryToBuildPreviewInfo(previewUrl: String?,
callbackQueue: DispatchQueue,
completion completionParam: @escaping (OWSLinkPreviewDraft?) -> Void) {
// Ensure we invoke completion on the callback queue.
let completion = { (linkPreviewDraft) in
callbackQueue.async {
completionParam(linkPreviewDraft)
}
}
guard OWSLinkPreview.featureEnabled else { guard OWSLinkPreview.featureEnabled else {
completion(nil) return Promise(error: LinkPreviewError.featureDisabled)
return
} }
guard SSKPreferences.areLinkPreviewsEnabled() else { guard SSKPreferences.areLinkPreviewsEnabled() else {
completion(nil) return Promise(error: LinkPreviewError.featureDisabled)
return
} }
guard let previewUrl = previewUrl else { guard let previewUrl = previewUrl else {
completion(nil) return Promise(error: LinkPreviewError.invalidInput)
return
} }
serialQueue.async { if let cachedInfo = cachedLinkPreview(forPreviewUrl: previewUrl) {
if let cachedInfo = linkPreviewDraftCache.object(forKey: previewUrl as AnyObject) { Logger.verbose("Link preview info cache hit.")
Logger.verbose("Link preview info cache hit.") return Promise.value(cachedInfo)
completion(cachedInfo) }
return return downloadLink(url: previewUrl)
} .then(on: DispatchQueue.global()) { (data) -> Promise<OWSLinkPreviewDraft> in
downloadLink(url: previewUrl, completion: { (data) in return parse(linkData: data, linkUrlString: previewUrl)
DispatchQueue.global().async { .then(on: DispatchQueue.global()) { (linkPreviewDraft) -> Promise<OWSLinkPreviewDraft> in
guard let data = data else {
completion(nil)
return
}
parse(linkData: data, linkUrlString: previewUrl) { (linkPreviewDraft) in
guard let linkPreviewDraft = linkPreviewDraft else {
completion(nil)
return
}
guard linkPreviewDraft.isValid() else { guard linkPreviewDraft.isValid() else {
completion(nil) return Promise(error: LinkPreviewError.noPreview)
return
} }
serialQueue.async { setCachedLinkPreview(linkPreviewDraft, forPreviewUrl: previewUrl)
previewUrlCache.setObject(linkPreviewDraft, forKey: previewUrl as AnyObject)
completion(linkPreviewDraft) return Promise.value(linkPreviewDraft)
}
}
} }
})
} }
} }
private class func downloadLink(url: String, private class func downloadLink(url: String,
completion: @escaping (Data?) -> Void, remainingRetries: UInt = 3) -> Promise<Data> {
remainingRetries: UInt = 3) {
Logger.verbose("url: \(url)") Logger.verbose("url: \(url)")
@ -507,6 +503,7 @@ public class OWSLinkPreview: MTLModel {
sessionManager.requestSerializer.setValue(nil, forHTTPHeaderField: headerField) sessionManager.requestSerializer.setValue(nil, forHTTPHeaderField: headerField)
} }
let (promise, resolver) = Promise<Data>.pending()
sessionManager.get(url, sessionManager.get(url,
parameters: [String: AnyObject](), parameters: [String: AnyObject](),
progress: nil, progress: nil,
@ -514,65 +511,68 @@ public class OWSLinkPreview: MTLModel {
guard let data = value as? Data else { guard let data = value as? Data else {
Logger.warn("Result is not data: \(type(of: value)).") Logger.warn("Result is not data: \(type(of: value)).")
completion(nil) resolver.reject( LinkPreviewError.assertionFailure)
return return
} }
completion(data) resolver.fulfill(data)
}, },
failure: { _, error in failure: { _, error in
Logger.verbose("Error: \(error)") Logger.verbose("Error: \(error)")
guard isRetryable(error: error) else { guard isRetryable(error: error) else {
Logger.warn("Error is not retryable.") Logger.warn("Error is not retryable.")
completion(nil) resolver.reject( LinkPreviewError.couldNotDownload)
return return
} }
guard remainingRetries > 0 else { guard remainingRetries > 0 else {
Logger.warn("No more retries.") Logger.warn("No more retries.")
completion(nil) resolver.reject( LinkPreviewError.couldNotDownload)
return return
} }
OWSLinkPreview.downloadLink(url: url, completion: completion, remainingRetries: remainingRetries - 1) OWSLinkPreview.downloadLink(url: url, remainingRetries: remainingRetries - 1)
.done(on: DispatchQueue.global()) { (data) in
resolver.fulfill(data)
}.catch(on: DispatchQueue.global()) { (error) in
resolver.reject( error)
}.retainUntilComplete()
}) })
return promise
} }
private class func downloadImage(url urlString: String, private class func downloadImage(url urlString: String) -> Promise<Data> {
completion: @escaping (Data?) -> Void) {
Logger.verbose("url: \(urlString)") Logger.verbose("url: \(urlString)")
guard let url = URL(string: urlString) else { guard let url = URL(string: urlString) else {
Logger.error("Could not parse URL.") Logger.error("Could not parse URL.")
return completion(nil) return Promise(error: LinkPreviewError.invalidInput)
} }
guard let assetDescription = ProxiedContentAssetDescription(url: url as NSURL) else { guard let assetDescription = ProxiedContentAssetDescription(url: url as NSURL) else {
Logger.error("Could not create asset description.") Logger.error("Could not create asset description.")
return completion(nil) return Promise(error: LinkPreviewError.invalidInput)
} }
let (promise, resolver) = Promise<ProxiedContentAsset>.pending()
DispatchQueue.main.async { DispatchQueue.main.async {
_ = ProxiedContentDownloader.defaultDownloader.requestAsset(assetDescription: assetDescription, _ = ProxiedContentDownloader.defaultDownloader.requestAsset(assetDescription: assetDescription,
priority: .high, priority: .high,
success: { (_, asset) in success: { (_, asset) in
DispatchQueue.global().async { resolver.fulfill(asset)
do {
let data = try Data(contentsOf: URL(fileURLWithPath: asset.filePath))
completion(data)
} catch {
owsFailDebug("Could not load asset data: \(type(of: asset.filePath)).")
completion(nil)
}
}
}, failure: { (_) in }, failure: { (_) in
DispatchQueue.global().async { Logger.warn("Error downloading asset")
Logger.verbose("Error downloading asset") resolver.reject(LinkPreviewError.couldNotDownload)
completion(nil)
}
}) })
} }
return promise.then(on: DispatchQueue.global()) { (asset: ProxiedContentAsset) -> Promise<Data> in
do {
let data = try Data(contentsOf: URL(fileURLWithPath: asset.filePath))
return Promise.value(data)
} catch {
owsFailDebug("Could not load asset data: \(type(of: asset.filePath)).")
return Promise(error: LinkPreviewError.assertionFailure)
}
}
} }
private class func isRetryable(error: Error) -> Bool { private class func isRetryable(error: Error) -> Bool {
@ -589,12 +589,10 @@ public class OWSLinkPreview: MTLModel {
// <meta property="og:title" content="Randomness is Random - Numberphile"> // <meta property="og:title" content="Randomness is Random - Numberphile">
// <meta property="og:image" content="https://i.ytimg.com/vi/tP-Ipsat90c/maxresdefault.jpg"> // <meta property="og:image" content="https://i.ytimg.com/vi/tP-Ipsat90c/maxresdefault.jpg">
private class func parse(linkData: Data, private class func parse(linkData: Data,
linkUrlString: String, linkUrlString: String) -> Promise<OWSLinkPreviewDraft> {
completion: @escaping (OWSLinkPreviewDraft?) -> Void) {
guard let linkText = String(bytes: linkData, encoding: .utf8) else { guard let linkText = String(bytes: linkData, encoding: .utf8) else {
owsFailDebug("Could not parse link text.") owsFailDebug("Could not parse link text.")
completion(nil) return Promise(error: LinkPreviewError.invalidInput)
return
} }
var title: String? var title: String?
@ -610,25 +608,25 @@ public class OWSLinkPreview: MTLModel {
Logger.verbose("title: \(String(describing: title))") Logger.verbose("title: \(String(describing: title))")
guard let rawImageUrlString = NSRegularExpression.parseFirstMatch(pattern: "<meta\\s+property\\s*=\\s*\"og:image\"\\s+content\\s*=\\s*\"(.*?)\"\\s*/?>", text: linkText) else { guard let rawImageUrlString = NSRegularExpression.parseFirstMatch(pattern: "<meta\\s+property\\s*=\\s*\"og:image\"\\s+content\\s*=\\s*\"(.*?)\"\\s*/?>", text: linkText) else {
return completion(OWSLinkPreviewDraft(urlString: linkUrlString, title: title)) return Promise.value(OWSLinkPreviewDraft(urlString: linkUrlString, title: title))
} }
guard let imageUrlString = decodeHTMLEntities(inString: rawImageUrlString)?.ows_stripped() else { guard let imageUrlString = decodeHTMLEntities(inString: rawImageUrlString)?.ows_stripped() else {
return completion(OWSLinkPreviewDraft(urlString: linkUrlString, title: title)) return Promise.value(OWSLinkPreviewDraft(urlString: linkUrlString, title: title))
} }
guard isValidMediaUrl(imageUrlString) else { guard isValidMediaUrl(imageUrlString) else {
Logger.error("Invalid image URL.") Logger.error("Invalid image URL.")
return completion(OWSLinkPreviewDraft(urlString: linkUrlString, title: title)) return Promise.value(OWSLinkPreviewDraft(urlString: linkUrlString, title: title))
} }
Logger.verbose("imageUrlString: \(imageUrlString)") Logger.verbose("imageUrlString: \(imageUrlString)")
guard let imageUrl = URL(string: imageUrlString) else { guard let imageUrl = URL(string: imageUrlString) else {
Logger.error("Could not parse image URL.") Logger.error("Could not parse image URL.")
return completion(OWSLinkPreviewDraft(urlString: linkUrlString, title: title)) return Promise.value(OWSLinkPreviewDraft(urlString: linkUrlString, title: title))
} }
let imageFilename = imageUrl.lastPathComponent let imageFilename = imageUrl.lastPathComponent
let imageFileExtension = (imageFilename as NSString).pathExtension.lowercased() let imageFileExtension = (imageFilename as NSString).pathExtension.lowercased()
guard let imageMimeType = MIMETypeUtil.mimeType(forFileExtension: imageFileExtension) else { guard let imageMimeType = MIMETypeUtil.mimeType(forFileExtension: imageFileExtension) else {
Logger.error("Image URL has unknown content type: \(imageFileExtension).") Logger.error("Image URL has unknown content type: \(imageFileExtension).")
return completion(OWSLinkPreviewDraft(urlString: linkUrlString, title: title)) return Promise.value(OWSLinkPreviewDraft(urlString: linkUrlString, title: title))
} }
let kValidMimeTypes = [ let kValidMimeTypes = [
OWSMimeTypeImagePng, OWSMimeTypeImagePng,
@ -636,36 +634,35 @@ public class OWSLinkPreview: MTLModel {
] ]
guard kValidMimeTypes.contains(imageMimeType) else { guard kValidMimeTypes.contains(imageMimeType) else {
Logger.error("Image URL has invalid content type: \(imageMimeType).") Logger.error("Image URL has invalid content type: \(imageMimeType).")
return completion(OWSLinkPreviewDraft(urlString: linkUrlString, title: title)) return Promise.value(OWSLinkPreviewDraft(urlString: linkUrlString, title: title))
} }
downloadImage(url: imageUrlString, return downloadImage(url: imageUrlString)
completion: { (imageData) in .then(on: DispatchQueue.global()) { (imageData: Data) -> Promise<OWSLinkPreviewDraft> in
guard let imageData = imageData else { let imageFilePath = OWSFileSystem.temporaryFilePath(withFileExtension: imageFileExtension)
Logger.error("Could not download image.") do {
return completion(OWSLinkPreviewDraft(urlString: linkUrlString, title: title)) try imageData.write(to: NSURL.fileURL(withPath: imageFilePath), options: .atomicWrite)
} } catch let error as NSError {
let imageFilePath = OWSFileSystem.temporaryFilePath(withFileExtension: imageFileExtension) owsFailDebug("file write failed: \(imageFilePath), \(error)")
do { return Promise(error: LinkPreviewError.assertionFailure)
try imageData.write(to: NSURL.fileURL(withPath: imageFilePath), options: .atomicWrite) }
} catch let error as NSError { // NOTE: imageSize(forFilePath:...) will call ows_isValidImage(...).
owsFailDebug("file write failed: \(imageFilePath), \(error)") let imageSize = NSData.imageSize(forFilePath: imageFilePath, mimeType: imageMimeType)
return completion(OWSLinkPreviewDraft(urlString: linkUrlString, title: title)) let kMaxImageSize: CGFloat = 2048
} guard imageSize.width > 0,
// NOTE: imageSize(forFilePath:...) will call ows_isValidImage(...). imageSize.height > 0,
let imageSize = NSData.imageSize(forFilePath: imageFilePath, mimeType: imageMimeType) imageSize.width < kMaxImageSize,
let kMaxImageSize: CGFloat = 2048 imageSize.height < kMaxImageSize else {
guard imageSize.width > 0, Logger.error("Image has invalid size: \(imageSize).")
imageSize.height > 0, return Promise(error: LinkPreviewError.assertionFailure)
imageSize.width < kMaxImageSize, }
imageSize.height < kMaxImageSize else {
Logger.error("Image has invalid size: \(imageSize).")
return completion(OWSLinkPreviewDraft(urlString: linkUrlString, title: title))
}
let linkPreviewDraft = OWSLinkPreviewDraft(urlString: linkUrlString, title: title, imageFilePath: imageFilePath) let linkPreviewDraft = OWSLinkPreviewDraft(urlString: linkUrlString, title: title, imageFilePath: imageFilePath)
completion(linkPreviewDraft) return Promise.value(linkPreviewDraft)
}) }
.recover(on: DispatchQueue.global()) { (_) -> Promise<OWSLinkPreviewDraft> in
return Promise.value(OWSLinkPreviewDraft(urlString: linkUrlString, title: title))
}
} }
private class func decodeHTMLEntities(inString value: String) -> String? { private class func decodeHTMLEntities(inString value: String) -> String? {

Loading…
Cancel
Save