| 1 | # Manage the POE::Kernel data structures necessary to keep track of | ||||||||||
| 2 | # session aliases. | ||||||||||
| 3 | |||||||||||
| 4 | package POE::Resource::Aliases; | ||||||||||
| 5 | |||||||||||
| 6 | 200 | ▶ | use vars qw($VERSION); | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 7 | 200 | $VERSION = '1.370'; # NOTE - Should be #.### (three decimal places) | |||||||||
| 8 | |||||||||||
| 9 | # These methods are folded into POE::Kernel; | ||||||||||
| 10 | package POE::Kernel; | ||||||||||
| 11 | |||||||||||
| 12 | 200 | ▶ | use strict; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 13 | |||||||||||
| 14 | ### The table of session aliases, and the sessions they refer to. | ||||||||||
| 15 | |||||||||||
| 16 | 200 | my %kr_aliases; | |||||||||
| 17 | # ( $alias => $session_ref, | ||||||||||
| 18 | # ..., | ||||||||||
| 19 | # ); | ||||||||||
| 20 | |||||||||||
| 21 | my %kr_ses_to_alias; | ||||||||||
| 22 | # ( $session_id => | ||||||||||
| 23 | # { $alias => $session_ref, | ||||||||||
| 24 | # ..., | ||||||||||
| 25 | # }, | ||||||||||
| 26 | # ..., | ||||||||||
| 27 | # ); | ||||||||||
| 28 | |||||||||||
| 29 | 198 | ▶ | sub _data_alias_initialize { | ||||||||
|
Subroutine
_data_alias_initialize: called CC=1 SCAR=0.0
| |||||||||||
| 30 | 198 | $poe_kernel->[KR_ALIASES] = \%kr_aliases; | |||||||||
| 31 | } | ||||||||||
| 32 | |||||||||||
| 33 | 10 | ▶ | sub _data_alias_relocate_kernel_id { | ||||||||
|
Subroutine
_data_alias_relocate_kernel_id: called CC=2 SCAR=8.1
| |||||||||||
| 34 | 10 | my ($self, $old_id, $new_id) = @_; | |||||||||
| 35 | 10 | ▶ | return unless exists $kr_ses_to_alias{$old_id}; | ||||||||
|
Branch: 1 branch
| |||||||||||
| 36 | 0 | $kr_ses_to_alias{$new_id} = delete $kr_ses_to_alias{$old_id}; | |||||||||
| 37 | } | ||||||||||
| 38 | |||||||||||
| 39 | ### End-run leak checking. Returns true if finalization was ok, or | ||||||||||
| 40 | ### false if it failed. | ||||||||||
| 41 | |||||||||||
| 42 | 204 | ▶ | sub _data_alias_finalize { | ||||||||
|
Subroutine
_data_alias_finalize: called CC=3 SCAR=14.8
| |||||||||||
| 43 | 204 | my $finalized_ok = 1; | |||||||||
| 44 | 204 | ▶ | while (my ($alias, $ses) = each(%kr_aliases)) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 45 | 0 | _warn "!!! Leaked alias: $alias = $ses\n"; | |||||||||
| 46 | 0 | $finalized_ok = 0; | |||||||||
| 47 | } | ||||||||||
| 48 | 204 | ▶ | while (my ($ses_id, $alias_rec) = each(%kr_ses_to_alias)) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 49 | 0 | my @aliases = keys(%$alias_rec); | |||||||||
| 50 | 0 | _warn "!!! Leaked alias cross-reference: $ses_id (@aliases)\n"; | |||||||||
| 51 | 0 | $finalized_ok = 0; | |||||||||
| 52 | } | ||||||||||
| 53 | 204 | return $finalized_ok; | |||||||||
| 54 | } | ||||||||||
| 55 | |||||||||||
| 56 | # Add an alias to a session. | ||||||||||
| 57 | # | ||||||||||
| 58 | # TODO This has a potential problem: setting the same alias twice on a | ||||||||||
| 59 | # session will increase the session's reference count twice. Removing | ||||||||||
| 60 | # the alias will only decrement it once. That potentially causes | ||||||||||
| 61 | # reference counts that never go away. The public interface for this | ||||||||||
| 62 | # function, alias_set(), does not allow this to occur. We should add | ||||||||||
| 63 | # a test to make sure it never does. | ||||||||||
| 64 | # | ||||||||||
| 65 | # TODO It is possible to add aliases to sessions that do not exist. | ||||||||||
| 66 | # The public alias_set() function prevents this from happening. | ||||||||||
| 67 | |||||||||||
| 68 | 153 | ▶ | sub _data_alias_add { | ||||||||
|
Subroutine
_data_alias_add: called CC=1 SCAR=0.0
| |||||||||||
| 69 | 153 | my ($self, $session, $alias) = @_; | |||||||||
| 70 | # _warn( "Session ", $session->ID, " is alias $alias\n" ); | ||||||||||
| 71 | 153 | $self->_data_ses_refcount_inc($session->ID); | |||||||||
| 72 | 153 | $kr_aliases{$alias} = $session; | |||||||||
| 73 | 153 | $kr_ses_to_alias{$session->ID}->{$alias} = $session; | |||||||||
| 74 | } | ||||||||||
| 75 | |||||||||||
| 76 | # Remove an alias from a session. | ||||||||||
| 77 | # | ||||||||||
| 78 | # TODO Happily allows the removal of aliases from sessions that don't | ||||||||||
| 79 | # exist. This will cause problems with reference counting. | ||||||||||
| 80 | |||||||||||
| 81 | 133 | ▶ | sub _data_alias_remove { | ||||||||
|
Subroutine
_data_alias_remove: called CC=1 SCAR=0.0
| |||||||||||
| 82 | 133 | my ($self, $session, $alias) = @_; | |||||||||
| 83 | # _warn( "Session ", $session->ID, " was alias $alias\n" ); | ||||||||||
| 84 | 133 | delete $kr_aliases{$alias}; | |||||||||
| 85 | 133 | delete $kr_ses_to_alias{$session->ID}->{$alias}; | |||||||||
| 86 | 133 | $self->_data_ses_refcount_dec($session->ID); | |||||||||
| 87 | } | ||||||||||
| 88 | |||||||||||
| 89 | ### Clear all the aliases from a session. | ||||||||||
| 90 | |||||||||||
| 91 | 817 | ▶ | sub _data_alias_clear_session { | ||||||||
|
Subroutine
_data_alias_clear_session: called CC=3 SCAR=11.0
| |||||||||||
| 92 | 817 | my ($self, $sid) = @_; | |||||||||
| 93 | 817 | ▶ | return unless exists $kr_ses_to_alias{$sid}; # avoid autoviv | ||||||||
|
Branch: 1 branch
| |||||||||||
| 94 | 128 | ▶ | while (my ($alias, $ses_ref) = each %{$kr_ses_to_alias{$sid}}) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 95 | 71 | $self->_data_alias_remove($ses_ref, $alias); | |||||||||
| 96 | } | ||||||||||
| 97 | 128 | delete $kr_ses_to_alias{$sid}; | |||||||||
| 98 | } | ||||||||||
| 99 | |||||||||||
| 100 | ### Resolve an alias. Just an alias. | ||||||||||
| 101 | |||||||||||
| 102 | 388 | ▶ | sub _data_alias_resolve { | ||||||||
|
Subroutine
_data_alias_resolve: called CC=2 SCAR=6.9
| |||||||||||
| 103 | 388 | my ($self, $alias) = @_; | |||||||||
| 104 | 388 | ▶ | return undef unless exists $kr_aliases{$alias}; | ||||||||
|
Branch: 1 branch
| |||||||||||
| 105 | 228 | return $kr_aliases{$alias}; | |||||||||
| 106 | } | ||||||||||
| 107 | |||||||||||
| 108 | ### Return a list of aliases for a session. | ||||||||||
| 109 | |||||||||||
| 110 | 8557 | ▶ | sub _data_alias_list { | ||||||||
|
Subroutine
_data_alias_list: called CC=2 SCAR=6.9
| |||||||||||
| 111 | 8557 | my ($self, $sid) = @_; | |||||||||
| 112 | 8557 | ▶ | return () unless exists $kr_ses_to_alias{$sid}; | ||||||||
|
Branch: 1 branch
| |||||||||||
| 113 | 8556 | return sort keys %{$kr_ses_to_alias{$sid}}; | |||||||||
| 114 | } | ||||||||||
| 115 | |||||||||||
| 116 | ### Return the number of aliases for a session. | ||||||||||
| 117 | |||||||||||
| 118 | 4809 | ▶ | sub _data_alias_count_ses { | ||||||||
|
Subroutine
_data_alias_count_ses: called CC=2 SCAR=6.9
| |||||||||||
| 119 | 4809 | my ($self, $sid) = @_; | |||||||||
| 120 | 4809 | ▶ | return 0 unless exists $kr_ses_to_alias{$sid}; | ||||||||
|
Branch: 1 branch
| |||||||||||
| 121 | 1487 | return scalar keys %{$kr_ses_to_alias{$sid}}; | |||||||||
| 122 | } | ||||||||||
| 123 | |||||||||||
| 124 | ### Return a session's ID in a form suitable for logging. | ||||||||||
| 125 | |||||||||||
| 126 | 37586 | ▶ | sub _data_alias_loggable { | ||||||||
|
Subroutine
_data_alias_loggable: called CC=2 SCAR=6.9
| |||||||||||
| 127 | 37586 | my ($self, $sid) = @_; | |||||||||
| 128 | "session $sid" . ( | ||||||||||
| 129 | 37586 | ▶ | (exists $kr_ses_to_alias{$sid}) | ||||||||
|
Branch: 1 branch
| |||||||||||
| 130 | ? ( " (" . join(", ", $self->_data_alias_list($sid)) . ")" ) | ||||||||||
| 131 | : "" | ||||||||||
| 132 | ); | ||||||||||
| 133 | } | ||||||||||
| 134 | |||||||||||
| 135 | 200 | 1; | |||||||||
| 136 | |||||||||||
| 137 | __END__ | ||||||||||