1<?php
2/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
3
4/**
5 * DNS Library for handling lookups and updates.
6 *
7 * PHP Version 5
8 *
9 * Copyright (c) 2010, Mike Pultz <mike@mikepultz.com>.
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 *
16 *   * Redistributions of source code must retain the above copyright
17 *     notice, this list of conditions and the following disclaimer.
18 *
19 *   * Redistributions in binary form must reproduce the above copyright
20 *     notice, this list of conditions and the following disclaimer in
21 *     the documentation and/or other materials provided with the
22 *     distribution.
23 *
24 *   * Neither the name of Mike Pultz nor the names of his contributors
25 *     may be used to endorse or promote products derived from this
26 *     software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
31 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
32 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
33 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
34 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
35 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
36 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRIC
37 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
38 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
39 * POSSIBILITY OF SUCH DAMAGE.
40 *
41 * @category  Networking
42 * @package   Net_DNS2
43 * @author    Mike Pultz <mike@mikepultz.com>
44 * @copyright 2010 Mike Pultz <mike@mikepultz.com>
45 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
46 * @version   SVN: $Id: CNAME.php 127 2011-12-03 03:29:39Z mike.pultz $
47 * @link      http://pear.php.net/package/Net_DNS2
48 * @since     File available since Release 0.6.0
49 *
50 */
51
52/**
53 * CNAME Resource Record - RFC1035 section 3.3.1
54 *
55 *    +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
56 *    /                     CNAME                     /
57 *    /                                               /
58 *    +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
59 *
60 * @category Networking
61 * @package  Net_DNS2
62 * @author   Mike Pultz <mike@mikepultz.com>
63 * @license  http://www.opensource.org/licenses/bsd-license.php  BSD License
64 * @link     http://pear.php.net/package/Net_DNS2
65 * @see      Net_DNS2_RR
66 *
67 */
68class Net_DNS2_RR_CNAME extends Net_DNS2_RR
69{
70    /*
71     * The canonical name
72     */
73    public $cname;
74
75    /**
76     * method to return the rdata portion of the packet as a string
77     *
78     * @return  string
79     * @access  protected
80     *
81     */
82    protected function rrToString()
83    {
84        return $this->cleanString($this->cname) . '.';
85    }
86
87    /**
88     * parses the rdata portion from a standard DNS config line
89     *
90     * @param array $rdata a string split line of values for the rdata
91     *
92     * @return boolean
93     * @access protected
94     *
95     */
96    protected function rrFromString(array $rdata)
97    {
98        $this->cname = $this->cleanString(array_shift($rdata));
99        return true;
100    }
101
102    /**
103     * parses the rdata of the Net_DNS2_Packet object
104     *
105     * @param Net_DNS2_Packet &$packet a Net_DNS2_Packet packet to parse the RR from
106     *
107     * @return boolean
108     * @access protected
109     *
110     */
111    protected function rrSet(Net_DNS2_Packet &$packet)
112    {
113        if ($this->rdlength > 0) {
114
115            $offset = $packet->offset;
116            $this->cname = Net_DNS2_Packet::expand($packet, $offset);
117
118            return true;
119        }
120
121        return false;
122    }
123
124    /**
125     * returns the rdata portion of the DNS packet
126     *
127     * @param Net_DNS2_Packet &$packet a Net_DNS2_Packet packet use for
128     *                                 compressed names
129     *
130     * @return mixed                   either returns a binary packed
131     *                                 string or null on failure
132     * @access protected
133     *
134     */
135    protected function rrGet(Net_DNS2_Packet &$packet)
136    {
137        if (strlen($this->cname) > 0) {
138
139            return $packet->compress($this->cname, $packet->offset);
140        }
141
142        return null;
143    }
144}
145
146/*
147 * Local variables:
148 * tab-width: 4
149 * c-basic-offset: 4
150 * c-hanging-comment-ender-p: nil
151 * End:
152 */
153?>
154