| 1 | package Net::Nostr::Badge; | ||
| 2 | |||
| 3 | use strictures 2; | ||
| 4 | |||
| 5 | use Net::Nostr::_ConstructorArgs (); | ||
| 6 | |||
| 7 | use Carp qw(croak); | ||
| 8 | use Net::Nostr::Event; | ||
| 9 | |||
| 10 | use Class::Tiny qw( | ||
| 11 | identifier | ||
| 12 | name | ||
| 13 | description | ||
| 14 | image | ||
| 15 | thumbs | ||
| 16 | badge | ||
| 17 | awardees | ||
| 18 | badges | ||
| 19 | badge_sets | ||
| 20 | ); | ||
| 21 | |||
| 22 | sub new { | ||
| 23 | my $class = shift; | ||
| 24 | my %args = Net::Nostr::_ConstructorArgs::normalize(@_); | ||
| 25 | $args{thumbs} //= []; | ||
| 26 | $args{awardees} //= []; | ||
| 27 | $args{badges} //= []; | ||
| 28 | $args{badge_sets} //= []; | ||
| 29 | my $self = bless { %args }, $class; | ||
| 30 | my %known; @known{Class::Tiny->get_all_attributes_for($class)} = (); | ||
| 31 | my @unknown = grep { !exists $known{$_} } keys %$self; | ||
| 32 | croak "unknown argument(s): " . join(', ', sort @unknown) if @unknown; | ||
| 33 | return $self; | ||
| 34 | } | ||
| 35 | |||
| 36 | sub definition { | ||
| 37 | my $class = shift; | ||
| 38 | my %args = Net::Nostr::_ConstructorArgs::normalize(@_); | ||
| 39 | |||
| 40 | my $identifier = delete $args{identifier} | ||
| 41 | // croak "definition requires 'identifier'"; | ||
| 42 | |||
| 43 | my @tags; | ||
| 44 | push @tags, ['d', $identifier]; | ||
| 45 | |||
| 46 | push @tags, ['name', delete $args{name}] if defined $args{name}; | ||
| 47 | delete $args{name}; | ||
| 48 | |||
| 49 | push @tags, ['description', delete $args{description}] if defined $args{description}; | ||
| 50 | delete $args{description}; | ||
| 51 | |||
| 52 | if (my $image = delete $args{image}) { | ||
| 53 | push @tags, ['image', @$image]; | ||
| 54 | } | ||
| 55 | |||
| 56 | if (my $thumbs = delete $args{thumbs}) { | ||
| 57 | for my $thumb (@$thumbs) { | ||
| 58 | push @tags, ['thumb', @$thumb]; | ||
| 59 | } | ||
| 60 | } | ||
| 61 | |||
| 62 | return Net::Nostr::Event->new( | ||
| 63 | %args, | ||
| 64 | kind => 30009, | ||
| 65 | content => '', | ||
| 66 | tags => \@tags, | ||
| 67 | ); | ||
| 68 | } | ||
| 69 | |||
| 70 | sub award { | ||
| 71 | my $class = shift; | ||
| 72 | my %args = Net::Nostr::_ConstructorArgs::normalize(@_); | ||
| 73 | |||
| 74 | my $badge = delete $args{badge} | ||
| 75 | // croak "award requires 'badge'"; | ||
| 76 | my $awardees = delete $args{awardees} | ||
| 77 | // croak "award requires 'awardees'"; | ||
| 78 | |||
| 79 | croak "award requires at least one awardee" unless @$awardees; | ||
| 80 | |||
| 81 | my @tags; | ||
| 82 | push @tags, ['a', $badge]; | ||
| 83 | |||
| 84 | for my $awardee (@$awardees) { | ||
| 85 | push @tags, ['p', @$awardee]; | ||
| 86 | } | ||
| 87 | |||
| 88 | return Net::Nostr::Event->new( | ||
| 89 | %args, | ||
| 90 | kind => 8, | ||
| 91 | content => '', | ||
| 92 | tags => \@tags, | ||
| 93 | ); | ||
| 94 | } | ||
| 95 | |||
| 96 | sub profile_badges { | ||
| 97 | my $class = shift; | ||
| 98 | my %args = Net::Nostr::_ConstructorArgs::normalize(@_); | ||
| 99 | |||
| 100 | my $badges = delete $args{badges} | ||
| 101 | // croak "profile_badges requires 'badges'"; | ||
| 102 | my $badge_sets = delete $args{badge_sets}; | ||
| 103 | |||
| 104 | my @tags; | ||
| 105 | for my $entry (@$badges) { | ||
| 106 | push @tags, ['a', $entry->{definition}]; | ||
| 107 | my @e = ('e', $entry->{award}); | ||
| 108 | push @e, $entry->{award_relay} if defined $entry->{award_relay}; | ||
| 109 | push @tags, \@e; | ||
| 110 | } | ||
| 111 | |||
| 112 | if ($badge_sets) { | ||
| 113 | for my $set (@$badge_sets) { | ||
| 114 | push @tags, ['a', $set]; | ||
| 115 | } | ||
| 116 | } | ||
| 117 | |||
| 118 | return Net::Nostr::Event->new( | ||
| 119 | %args, | ||
| 120 | kind => 10008, | ||
| 121 | content => '', | ||
| 122 | tags => \@tags, | ||
| 123 | ); | ||
| 124 | } | ||
| 125 | |||
| 126 | sub badge_set { | ||
| 127 | my $class = shift; | ||
| 128 | my %args = Net::Nostr::_ConstructorArgs::normalize(@_); | ||
| 129 | |||
| 130 | my $identifier = delete $args{identifier} | ||
| 131 | // croak "badge_set requires 'identifier'"; | ||
| 132 | my $badges = delete $args{badges} | ||
| 133 | // croak "badge_set requires 'badges'"; | ||
| 134 | |||
| 135 | my @tags; | ||
| 136 | push @tags, ['d', $identifier]; | ||
| 137 | |||
| 138 | for my $entry (@$badges) { | ||
| 139 | push @tags, ['a', $entry->{definition}]; | ||
| 140 | my @e = ('e', $entry->{award}); | ||
| 141 | push @e, $entry->{award_relay} if defined $entry->{award_relay}; | ||
| 142 | push @tags, \@e; | ||
| 143 | } | ||
| 144 | |||
| 145 | return Net::Nostr::Event->new( | ||
| 146 | %args, | ||
| 147 | kind => 30008, | ||
| 148 | content => '', | ||
| 149 | tags => \@tags, | ||
| 150 | ); | ||
| 151 | } | ||
| 152 | |||
| 153 | sub from_event { | ||
| 154 | my ($class, $event) = @_; | ||
| 155 | my $kind = $event->kind; | ||
| 156 | |||
| 157 | if ($kind == 30009) { | ||
| 158 | return $class->_parse_definition($event); | ||
| 159 | } elsif ($kind == 8) { | ||
| 160 | return $class->_parse_award($event); | ||
| 161 | } elsif ($kind == 10008) { | ||
| 162 | return $class->_parse_profile_badges($event); | ||
| 163 | } elsif ($kind == 30008) { | ||
| 164 | return $class->_parse_badge_set($event); | ||
| 165 | } | ||
| 166 | |||
| 167 | return undef; | ||
| 168 | } | ||
| 169 | |||
| 170 | sub _parse_definition { | ||
| 171 | my ($class, $event) = @_; | ||
| 172 | |||
| 173 | my ($identifier, $name, $description, $image, @thumbs); | ||
| 174 | |||
| 175 | for my $tag (@{$event->tags}) { | ||
| 176 | my $t = $tag->[0]; | ||
| 177 | if ($t eq 'd') { | ||
| 178 | $identifier = $tag->[1]; | ||
| 179 | } elsif ($t eq 'name') { | ||
| 180 | $name = $tag->[1]; | ||
| 181 | } elsif ($t eq 'description') { | ||
| 182 | $description = $tag->[1]; | ||
| 183 | } elsif ($t eq 'image') { | ||
| 184 | $image = [@{$tag}[1 .. $#$tag]]; | ||
| 185 | } elsif ($t eq 'thumb') { | ||
| 186 | push @thumbs, [@{$tag}[1 .. $#$tag]]; | ||
| 187 | } | ||
| 188 | } | ||
| 189 | |||
| 190 | return $class->new( | ||
| 191 | identifier => $identifier, | ||
| 192 | name => $name, | ||
| 193 | description => $description, | ||
| 194 | image => $image, | ||
| 195 | thumbs => \@thumbs, | ||
| 196 | ); | ||
| 197 | } | ||
| 198 | |||
| 199 | sub _parse_award { | ||
| 200 | my ($class, $event) = @_; | ||
| 201 | |||
| 202 | my ($badge, @awardees); | ||
| 203 | |||
| 204 | for my $tag (@{$event->tags}) { | ||
| 205 | if ($tag->[0] eq 'a') { | ||
| 206 | $badge = $tag->[1]; | ||
| 207 | } elsif ($tag->[0] eq 'p') { | ||
| 208 | push @awardees, [@{$tag}[1 .. $#$tag]]; | ||
| 209 | } | ||
| 210 | } | ||
| 211 | |||
| 212 | return $class->new( | ||
| 213 | badge => $badge, | ||
| 214 | awardees => \@awardees, | ||
| 215 | ); | ||
| 216 | } | ||
| 217 | |||
| 218 | sub _parse_profile_badges { | ||
| 219 | my ($class, $event) = @_; | ||
| 220 | return $class->_parse_badge_pairs($event); | ||
| 221 | } | ||
| 222 | |||
| 223 | sub _parse_badge_set { | ||
| 224 | my ($class, $event) = @_; | ||
| 225 | |||
| 226 | my $identifier; | ||
| 227 | for my $tag (@{$event->tags}) { | ||
| 228 | if ($tag->[0] eq 'd') { | ||
| 229 | $identifier = $tag->[1]; | ||
| 230 | last; | ||
| 231 | } | ||
| 232 | } | ||
| 233 | |||
| 234 | # Deprecated: kind 30008 with d=profile_badges is treated as profile badges | ||
| 235 | if (defined $identifier && $identifier eq 'profile_badges') { | ||
| 236 | return $class->_parse_badge_pairs($event); | ||
| 237 | } | ||
| 238 | |||
| 239 | my $obj = $class->_parse_badge_pairs($event); | ||
| 240 | $obj->{identifier} = $identifier; | ||
| 241 | return $obj; | ||
| 242 | } | ||
| 243 | |||
| 244 | sub _parse_badge_pairs { | ||
| 245 | my ($class, $event) = @_; | ||
| 246 | |||
| 247 | my @badges; | ||
| 248 | my $pending_def; | ||
| 249 | |||
| 250 | for my $tag (@{$event->tags}) { | ||
| 251 | if ($tag->[0] eq 'a' && defined $tag->[1] && $tag->[1] =~ /^30009:/) { | ||
| 252 | # If we had a pending def without an e, discard it | ||
| 253 | $pending_def = $tag->[1]; | ||
| 254 | } elsif ($tag->[0] eq 'e' && defined $pending_def) { | ||
| 255 | my %entry = ( | ||
| 256 | definition => $pending_def, | ||
| 257 | award => $tag->[1], | ||
| 258 | ); | ||
| 259 | $entry{award_relay} = $tag->[2] if defined $tag->[2] && $tag->[2] ne ''; | ||
| 260 | push @badges, \%entry; | ||
| 261 | $pending_def = undef; | ||
| 262 | } elsif ($tag->[0] eq 'e') { | ||
| 263 | # e without preceding a -- ignore | ||
| 264 | } | ||
| 265 | } | ||
| 266 | |||
| 267 | return $class->new(badges => \@badges); | ||
| 268 | } | ||
| 269 | |||
| 270 | sub validate { | ||
| 271 | my ($class, $event) = @_; | ||
| 272 | my $kind = $event->kind; | ||
| 273 | |||
| 274 | croak "badge event MUST be kind 30009, 8, 10008, or 30008" | ||
| 275 | unless $kind == 30009 || $kind == 8 || $kind == 10008 || $kind == 30008; | ||
| 276 | |||
| 277 | if ($kind == 30009) { | ||
| 278 | my $has_d = grep { $_->[0] eq 'd' } @{$event->tags}; | ||
| 279 | croak "badge definition MUST have a 'd' tag" unless $has_d; | ||
| 280 | } | ||
| 281 | |||
| 282 | if ($kind == 8) { | ||
| 283 | my $has_a = grep { | ||
| 284 | $_->[0] eq 'a' && defined $_->[1] && $_->[1] =~ /^30009:/ | ||
| 285 | } @{$event->tags}; | ||
| 286 | croak "badge award MUST have an 'a' tag referencing a kind 30009 badge definition" unless $has_a; | ||
| 287 | my $has_p = grep { $_->[0] eq 'p' } @{$event->tags}; | ||
| 288 | croak "badge award MUST have at least one 'p' tag" unless $has_p; | ||
| 289 | } | ||
| 290 | |||
| 291 | if ($kind == 30008) { | ||
| 292 | my $has_d = grep { $_->[0] eq 'd' } @{$event->tags}; | ||
| 293 | croak "badge set MUST have a 'd' tag" unless $has_d; | ||
| 294 | } | ||
| 295 | |||
| 296 | return 1; | ||
| 297 | } | ||
| 298 | |||
| 299 | 1; | ||
| 300 | |||
| 301 | __END__ |