Author: zwoop
Date: Mon May 16 14:24:11 2011
New Revision: 1103747
URL: http://svn.apache.org/viewvc?rev=1103747&view=rev
Log:
TS-786 Add a perl module to edit a records.config configuration file
Added:
trafficserver/traffic/trunk/contrib/perl/ConfigMgmt/
trafficserver/traffic/trunk/contrib/perl/ConfigMgmt/lib/
trafficserver/traffic/trunk/contrib/perl/ConfigMgmt/lib/Apache/
trafficserver/traffic/trunk/contrib/perl/ConfigMgmt/lib/Apache/TS/
trafficserver/traffic/trunk/contrib/perl/ConfigMgmt/lib/Apache/TS/Config/
trafficserver/traffic/trunk/contrib/perl/ConfigMgmt/lib/Apache/TS/Config/Records.pm
Added:
trafficserver/traffic/trunk/contrib/perl/ConfigMgmt/lib/Apache/TS/Config/Records.pm
URL:
http://svn.apache.org/viewvc/trafficserver/traffic/trunk/contrib/perl/ConfigMgmt/lib/Apache/TS/Config/Records.pm?rev=1103747&view=auto
==============================================================================
---
trafficserver/traffic/trunk/contrib/perl/ConfigMgmt/lib/Apache/TS/Config/Records.pm
(added)
+++
trafficserver/traffic/trunk/contrib/perl/ConfigMgmt/lib/Apache/TS/Config/Records.pm
Mon May 16 14:24:11 2011
@@ -0,0 +1,166 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+############################################################################
+# This is a simple module to let you read, modify and add to an Apache
+# Traffic Server records.config file. The idea is that you would write a
+# simple script (like example below) to update a "stock" records.config with
+# the changes applicable to your application. This allows you to uprade to
+# a newer default config file from a new release, for example.
+#
+#
+# #!/usr/bin/perl
+#
+# use Apache::TS::Config::Records;
+#
+# my $recedit = new Apache::TS::Config::Records(file => "/tmp/records.config");
+#
+# $recedit->load();
+#
+# $recedit->set(conf => "proxy.config.log.extended_log_enabled",
+# val => "123");
+# $recedit->write("/tmp/records.config.new");
+#
+############################################################################
+
+package Apache::TS::Config::Records;
+
+use warnings;
+use strict;
+
+require 5.006;
+
+use Carp;
+
+our $VERSION = "1.0";
+
+
+#
+# Constructor
+#
+sub new {
+ my ($class, %args) = @_;
+ my $self = {};
+
+ $self->{filename} = $args{file}; # Filename to open when loading and
saving
+ $self->{_configs} = []; # Storage, and to to preserve order
+ $self->{_lookup} = {}; # For faster lookup, indexes into the
above
+ $self->{_ix} = -1; # Empty
+ bless $self, $class;
+
+ return $self;
+}
+
+
+#
+# Load a records.config file
+#
+sub load {
+ my $self = shift;
+ my %args = @_;
+ my $filename = $args{filename} || $self->{filename} || die "Need a
filename to load";
+
+ open(FH, "<$filename");
+ while (<FH>) {
+ chomp;
+ my @p = split(/\s+/, $_, 4);
+
+ push(@{$self->{_configs}}, [$_, \@p, 0]);
+
+ ++($self->{_ix});
+ next unless ($#p == 3) && (($p[0] eq "LOCAL") || ($p[0] eq "CONFIG"));
+
+ $self->{_lookup}->{$p[1]} = $self->{_ix};
+ }
+}
+
+
+#
+# Get an existing configuration line. This is useful for
+# detecting that a config exists or not, for example. The
+# return value is an anonymous array like
+#
+# [<line string>, [value split into 4 fields, flag if changed]
+#
+# You probably shouldn't modify this array.
+#
+sub get {
+ my $self = shift;
+ my %args = @_;
+ my $c = $args{conf} || $args{config} || $@[0];
+ my $ix = $self->{_lookup}->{$c};
+
+ return [] unless defined($ix);
+ return $self->{_configs}->[$ix];
+}
+
+
+#
+# Modify one configuration value
+#
+sub set {
+ my $self = shift;
+ my %args = @_;
+ my $c = $args{conf} || $args{config} || $@[0];
+ my $v = $args{val} || $args{value} || $@[1];
+ my $ix = $self->{_lookup}->{$c};
+
+ if (!defined($ix)) {
+ print "Error: set(): No such configuration exists: $c\n";
+ return;
+ }
+
+ my $val = $self->{_configs}->[$ix];
+
+ @{$val->[1]}[3] = $v;
+ $val->[2] = 1; # Modified
+}
+
+
+#
+# Append anything to the "end" of the configuration. We will assure that
+# no duplicated configurations are added.
+#
+sub append {
+ my $self = shift;
+ my %args = @_;
+}
+
+
+#
+# Write the new configuration file to STDOUT, or provided
+#
+sub write {
+ my $self = shift;
+ my %args = @_;
+ my $filename = $args{filename} || "-";
+
+ if ($filename ne "-") {
+ close(STDOUT);
+ open(STDOUT, ">$filename") || die "Can't open $filename for writing";
+ }
+
+ foreach (@{$self->{_configs}}) {
+ if ($_->[2]) {
+ # Modified
+ print join(" ", @{$_->[1]}), "\n";
+ } else {
+ print $_->[0], "\n";
+ }
+ }
+}
