This file is indexed.

/usr/share/perl5/NetSDS/Session.pm is in libnetsds-perl 1.301-3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
#===============================================================================
#
#       MODULE:  NetSDS::Session
#
#  DESCRIPTION:  Memcached based session data storage
#
#       AUTHOR:  Michael Bochkaryov (Rattler), <misha@rattler.kiev.ua>
#      COMPANY:  Net.Style
#
#===============================================================================

=head1 NAME

B<NetSDS::Session> - memcached based session storage API

=head1 SYNOPSIS

	use NetSDS::Session;

	# Connecting to Memcached server
	my $sess = NetSDS::Session->new(
		host => '12.34.56.78',
		port => '12345',
	);

	...

	# Retrieve session key somehow
	$session_key = $cgi->param('sess_key');

	$sess->open($session_key);

	my $filter = $sess->get('filter');
	...
	$sess->set('filter', $new_filter);
	...
	$sess->close();

	1;

=head1 DESCRIPTION

C<NetSDS::Session> module provides API to session data storage based on Memcached server.

Each session represented as hash reference structure identified by UUID string.
Most reasonable usage of this module is a temporary data storing for web based GUI
between HTTP requests. However it's possible to find some other tasks.

Internally session structure is transformed to/from JSON string when interacting with Memcached.

=cut

package NetSDS::Session;

use 5.8.0;
use strict;
use warnings;

use version; our $VERSION = '1.301';

use Cache::Memcached::Fast;
use JSON;

use base 'NetSDS::Class::Abstract';

=head1 CLASS API

=over

=item B<new(%params)> - class constructor

Constructor establish connection to memcached server and set default session parameters.

Parameters:

	* host - memcached server hostname or IP address (default: 127.0.0.1)
	* port - memcached server TCP port (default: 11211)

Example:

	my $sess_hdl = NetSDS::Session->new(
		host => '12.34.56.78',
		port => '99999',
	);

=cut

sub new {

	my ( $class, %params ) = @_;

	my $self = $class->SUPER::new(
		session_id   => undef,    # session id (UUID string)
		session_data => {},       # session data as hash reference
		%params
	);

	# Prepare server address string (host:port)
	my $mc_host = $params{'host'} || '127.0.0.1';
	my $mc_port = $params{'port'} || '11211';

	# Initialize memcached handler
	$self->{memcached} = Cache::Memcached::Fast->new(
		{
			servers           => [                      { address => $mc_host . ':' . $mc_port } ],
			serialize_methods => [ \&JSON::encode_json, \&JSON::decode_json ],
		}
	);

	if ( $self->{memcached} ) {
		return $self;
	} else {
		return $class->error("Can't create memcached connection handler");
	}

} ## end sub new

=item B<open($sess_id)> - open session

Retrieve session data from server by session key (UUID string)

If no session exists then empty hashref is returned.

=cut

sub open {

	my ( $self, $sess_id ) = @_;

	# Initialize session key and retrieve data
	$self->{_id}   = $sess_id;
	$self->{_data} = $self->{memcached}->get($sess_id);

	# If no such session stored then create empty hashref
	$self->{_data} ||= {};

	return $self;
}

=item B<id()> - get session id

Returns current session id.

Example:

	my $sess_id = $sess->id();

=cut

sub id {
	my $self = shift;
	return $self->{_id};
}

=item B<set($key, $value)> - set session parameter

Set new session parameter value identified by it's key.

Example:

	$sess->set('order', 'id desc');

=cut

sub set {
	my ( $self, $key, $value ) = @_;
	$self->{_data}->{$key} = $value;
	return 1;
}

=item B<get($key)> - get session parameter

Return session parameter value by it's key.

Example:

	my $order = $sess->get('order');

=cut

sub get {
	my ( $self, $key ) = @_;
	return $self->{_data}->{$key};
}

=item B<delete($key)> - delete session parameter by key

Delete session parameter by it's key.

Returns updated session data as hash reference.

Example:

	$sess->delete('order');

=cut

sub delete {
	my ( $self, $key ) = @_;

	delete $self->{_data}->{$key};
	return $self->{_data};
}

=item B<clear()> - clear session data

This method clears all session data.

Example:

	$sess->clear();

=cut

sub clear {
	my $self = shift;
	$self->{_data} = {};
}

=item B<sync()> - save session

Synchronize session data on Memcached server.

Example:

	$sess->sync();

=cut

sub sync {

	my $self = shift;

	return $self->id ? $self->{memcached}->set( $self->id, $self->{_data} ) : undef;

}

=item B<close()> - save and close session

This method save all data to server and clear current session id and data from object.

Example:

	$session->close();

=cut

sub close {

	my $self = shift;

	# Nothing to store for non existent session key
	unless ( $self->id ) {
		return undef;
	}

	# Store session data to memcached server
	# or clear it from server if it's empty
	if ( $self->{_data} == {} ) {
		$self->{memcached}->delete( $self->id );
	} else {
		$self->{memcached}->set( $self->id, $self->{_data} );
	}

	# Clear session id and data
	$self->{_id}   = undef;
	$self->{_data} = undef;

	return;
} ## end sub close

1;

__END__

=back

=head1 SEE ALSO

=over

=item * L<Cache::Memcached::Fast> - XS implementation of Memcached API

=item * L<JSON> - JSON encoding/decoding API

=back

=head1 AUTHORS

Michael Bochkaryov <misha@rattler.kiev.ua>

=head1 THANKS

Yana Kornienko - for initial module implementation

=head1 LICENSE

Copyright (C) 2008-2009 Net Style Ltd.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

=cut