Signal-iOS/SignalServiceKit/src/Util/NSData+Image.h
Evan Hahn 370ff654e7
Change license to AGPL
Change license to AGPL

This commit:

- Updates the `LICENSE` file

- Start every file with something like:

      // Copyright YEAR_FIRST_PUBLISHED Signal Messenger, LLC
      // SPDX-License-Identifier: AGPL-3.0-only

---

First, I removed existing license headers with this Ruby 3.1.2 script:

    require 'set'

    EXTENSIONS_TO_CHECK = Set['.h', '.hpp', '.cpp', '.m', '.mm', '.pch', '.swift']

    same = 0
    different = 0

    all_files = `git ls-files`.lines.map { |line| line.strip }
    all_files.each do |relative_path|
      if relative_path == 'Pods'
        next
      end

      unless EXTENSIONS_TO_CHECK.include? File.extname(relative_path)
        next
      end

      path = File.expand_path(relative_path)

      contents = File.read(path)
      new_contents = contents.sub(/\/\/\n\/\/  Copyright .*\n\/\/\n\n/, '')

      if contents == new_contents
        same += 1
      else
        different += 1
      end

      File.write(path, new_contents)
    end

    puts "updated #{different} file(s), left #{same} untouched"

I'm sure this script could be improved, but it worked well enough.

Then, I created `Scripts/lint/lint-license-headers` and ran it to auto-
fix a lot of files. This changed the mode of some files, but I think
that's actually desirable. For example,
`SignalServiceKit/src/Util/AppContext.m` previously had a mode of
`0755/-rwxr-xr-x`, and it's now `0644/-rw-r--r--`.

Then I fixed some stragglers and updated the precommit script.

See [a similar change in the Desktop app][0].

[0]: 8bfaf598af
2022-10-13 08:25:37 -05:00

91 lines
2.9 KiB
Objective-C

//
// Copyright 2017 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
//
NS_ASSUME_NONNULL_BEGIN
typedef NS_CLOSED_ENUM(NSInteger, ImageFormat) {
ImageFormat_Unknown,
ImageFormat_Png,
ImageFormat_Gif,
ImageFormat_Tiff,
ImageFormat_Jpeg,
ImageFormat_Bmp,
ImageFormat_Webp,
ImageFormat_Heic,
ImageFormat_Heif,
ImageFormat_LottieSticker,
};
NSString *NSStringForImageFormat(ImageFormat value);
NSString *_Nullable MIMETypeForImageFormat(ImageFormat value);
#pragma mark -
@interface ImageMetadata : NSObject
@property (nonatomic, readonly) BOOL isValid;
// These properties are only set if isValid is true.
@property (nonatomic, readonly) ImageFormat imageFormat;
@property (nonatomic, readonly) CGSize pixelSize;
@property (nonatomic, readonly) BOOL hasAlpha;
@property (nonatomic, readonly) BOOL isAnimated;
@property (nonatomic, readonly, nullable) NSString *mimeType;
@property (nonatomic, readonly, nullable) NSString *fileExtension;
@end
#pragma mark -
@interface NSData (Image)
// If mimeType is non-nil, we ensure that the magic numbers agree with the
// mimeType.
+ (BOOL)ows_isValidImageAtUrl:(NSURL *)fileUrl mimeType:(nullable NSString *)mimeType;
+ (BOOL)ows_isValidImageAtPath:(NSString *)filePath;
+ (BOOL)ows_isValidImageAtPath:(NSString *)filePath mimeType:(nullable NSString *)mimeType;
- (BOOL)ows_isValidImage;
- (BOOL)ows_isValidImageWithMimeType:(nullable NSString *)mimeType;
// Returns the image size in pixels.
//
// Returns CGSizeZero on error.
+ (CGSize)imageSizeForFilePath:(NSString *)filePath mimeType:(nullable NSString *)mimeType;
+ (BOOL)hasAlphaForValidImageFilePath:(NSString *)filePath;
@property (nonatomic, readonly) BOOL isMaybeWebpData;
- (nullable UIImage *)stillForWebpData;
+ (BOOL)ows_hasStickerLikePropertiesWithPath:(NSString *)filePath;
- (BOOL)ows_hasStickerLikeProperties;
#pragma mark - Image Metadata
// declaredMimeType is optional.
// If present, it is used to validate the file format contents.
+ (ImageMetadata *)imageMetadataWithPath:(NSString *)filePath mimeType:(nullable NSString *)declaredMimeType;
+ (ImageMetadata *)imageMetadataWithPath:(NSString *)filePath
mimeType:(nullable NSString *)declaredMimeType
ignoreFileSize:(BOOL)ignoreFileSize;
// filePath and declaredMimeType are optional.
// If present, they are used to validate the file format contents.
// Returns nil if file size > OWSMediaUtils.kMaxFileSizeImage or animated file size >
// OWSMediaUtils.kMaxFileSizeAnimatedImage
- (ImageMetadata *)imageMetadataWithPath:(nullable NSString *)filePath mimeType:(nullable NSString *)declaredMimeType;
- (ImageMetadata *)imageMetadataWithPath:(nullable NSString *)filePath
mimeType:(nullable NSString *)declaredMimeType
ignoreFileSize:(BOOL)ignoreFileSize;
@end
NS_ASSUME_NONNULL_END