Signal-iOS/SignalServiceKit/src/groups/TSGroupModel.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

79 lines
2.6 KiB
Objective-C

//
// Copyright 2017 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
//
#import <Mantle/MTLModel+NSCoding.h>
#import <SignalServiceKit/ContactsManagerProtocol.h>
NS_ASSUME_NONNULL_BEGIN
@class GroupAccess;
@class GroupMembership;
@class SignalServiceAddress;
extern const int32_t kGroupIdLengthV1;
extern const int32_t kGroupIdLengthV2;
typedef NS_CLOSED_ENUM(uint32_t, GroupsVersion) {
GroupsVersionV1 = 0,
GroupsVersionV2
};
typedef NS_CLOSED_ENUM(NSUInteger, TSGroupMemberRole) {
TSGroupMemberRole_Normal = 0,
TSGroupMemberRole_Administrator = 1
};
typedef NS_CLOSED_ENUM(NSUInteger, TSGroupModelComparisonMode) {
TSGroupModelComparisonMode_CompareAll,
TSGroupModelComparisonMode_UserFacingOnly,
};
// NOTE: This class is tightly coupled to TSGroupModelBuilder.
// If you modify this class - especially if you
// add any new properties - make sure to update
// TSGroupModelBuilder.
@interface TSGroupModel : MTLModel
// groupMembers includes administrators and normal members.
@property (nonatomic, readonly) NSArray<SignalServiceAddress *> *groupMembers;
// The contents of groupMembers, excluding the local user.
@property (nonatomic, readonly) NSArray<SignalServiceAddress *> *nonLocalGroupMembers;
@property (nonatomic, readonly, nullable) NSString *groupName;
@property (nonatomic, readonly) NSData *groupId;
@property (nonatomic, readonly, nullable) SignalServiceAddress *addedByAddress;
#if TARGET_OS_IOS
// This data should always be in PNG format.
@property (nonatomic, nullable) NSData *legacyAvatarData;
@property (nonatomic, nullable) NSString *avatarHash;
@property (nonatomic, readonly) GroupsVersion groupsVersion;
@property (nonatomic, readonly) GroupMembership *groupMembership;
+ (BOOL)isValidGroupAvatarData:(nullable NSData *)imageData;
+ (nullable NSData *)dataForGroupAvatar:(nullable UIImage *)image;
+ (instancetype)new NS_UNAVAILABLE;
- (instancetype)init NS_UNAVAILABLE;
- (nullable instancetype)initWithCoder:(NSCoder *)coder NS_DESIGNATED_INITIALIZER;
- (instancetype)initWithGroupId:(NSData *)groupId
name:(nullable NSString *)name
avatarData:(nullable NSData *)avatarData
members:(NSArray<SignalServiceAddress *> *)members
addedByAddress:(nullable SignalServiceAddress *)addedByAddress NS_DESIGNATED_INITIALIZER;
- (BOOL)isEqual:(id)other;
- (BOOL)isEqualToGroupModel:(TSGroupModel *)model comparisonMode:(TSGroupModelComparisonMode)comparisonMode;
#endif
@property (nonatomic, readonly) NSString *groupNameOrDefault;
+ (NSData *)generateRandomV1GroupId;
@end
NS_ASSUME_NONNULL_END