PHP - convert_uuencode() and convert_uudecode()

This section provides the source code of the PHP implementation of UUEncode by php.net.

If you are interested in how UUEncode can be implemented in PHP, here is a copy of the source code of the PHP implementation the UUEncode encoding algorithm by php.net, convert_uuencode.php:

<?php
// ------------------------------------------------------------------
// PHP Version 4                                                     
// ------------------------------------------------------------------
// Copyright (c) 1997-2004 The PHP Group                             
// ------------------------------------------------------------------
// This source file is subject to version 3.0 of the PHP license,    
// that is bundled with this package in the file LICENSE, and is     
// available at through the world-wide-web at                        
// http://www.php.net/license/3_0.txt.                               
// If you did not receive a copy of the PHP license and are unable to
// obtain it through the world-wide-web, please send a note to       
// license@php.net so we can mail you a copy immediately.            
// ------------------------------------------------------------------
// Authors: Michael Wallner <mike@php.net>                           
//          Aidan Lister <aidan@php.net>                             
// ------------------------------------------------------------------
//
// $Id: convert_uuencode.php,v 1.7 2005/01/26 04:55:13 aidan Exp $


/**
 * Replace convert_uuencode()
 *
 * @category    PHP
 * @package     PHP_Compat
 * @link        http://php.net/function.convert_uuencode
 * @author      Michael Wallner <mike@php.net>
 * @author      Aidan Lister <aidan@php.net>
 * @version     $Revision: 1.7 $
 * @since       PHP 5
 * @require     PHP 4.0.0 (user_error)
 */
if (!function_exists('convert_uuencode')) {
    function convert_uuencode($string)
    {
        // Sanity check
        if (!is_scalar($string)) {
            user_error('convert_uuencode() expects parameter 1 to be'
                . ' string, ' . gettype($string) . ' given', 
                E_USER_WARNING);
            return false;
        }

        $u = 0;
        $encoded = '';
        
        while ($c = count($bytes = unpack('c*', 
            substr($string, $u, 45)))) {
            $u += 45;
            $encoded .= pack('c', $c + 0x20);

            while ($c % 3) {
                $bytes[++$c] = 0;
            }

            foreach (array_chunk($bytes, 3) as $b) {
                $b0 = ($b[0] & 0xFC) >> 2;
                $b1 = (($b[0] & 0x03) << 4) + (($b[1] & 0xF0) >> 4);
                $b2 = (($b[1] & 0x0F) << 2) + (($b[2] & 0xC0) >> 6);
                $b3 = $b[2] & 0x3F;
                
                $b0 = $b0 ? $b0 + 0x20 : 0x60;
                $b1 = $b1 ? $b1 + 0x20 : 0x60;
                $b2 = $b2 ? $b2 + 0x20 : 0x60;
                $b3 = $b3 ? $b3 + 0x20 : 0x60;
                
                $encoded .= pack('c*', $b0, $b1, $b2, $b3);
            }

            $encoded .= "\n";
        }
        
        // Add termination characters
        $encoded .= "\x60\n";

        return $encoded;
    }
}
?>

A copy of the source of the decoding process is listed below: convert_uudecode.php:

<?php
// ------------------------------------------------------------------
// PHP Version 4                                                     
// ------------------------------------------------------------------
// Copyright (c) 1997-2004 The PHP Group                             
// ------------------------------------------------------------------
// This source file is subject to version 3.0 of the PHP license,    
// that is bundled with this package in the file LICENSE, and is     
// available at through the world-wide-web at                        
// http://www.php.net/license/3_0.txt.                               
// If you did not receive a copy of the PHP license and are unable to
// obtain it through the world-wide-web, please send a note to       
// license@php.net so we can mail you a copy immediately.            
// ------------------------------------------------------------------
// Authors: Michael Wallner <mike@php.net>                     
//          Aidan Lister <aidan@php.net>                       
// ------------------------------------------------------------------
//
// $Id: convert_uudecode.php,v 1.8 2005/01/26 04:55:13 aidan Exp $


/**
 * Replace convert_uudecode()
 *
 * @category    PHP
 * @package     PHP_Compat
 * @link        http://php.net/function.convert_uudecode
 * @author      Michael Wallner <mike@php.net>
 * @author      Aidan Lister <aidan@php.net>
 * @version     $Revision: 1.8 $
 * @since       PHP 5
 * @require     PHP 4.0.0 (user_error)
 */
if (!function_exists('convert_uudecode')) {
    function convert_uudecode($string)
    {
        // Sanity check
        if (!is_scalar($string)) {
            user_error('convert_uuencode() expects parameter 1 to be'
                . ' string, ' . gettype($string) . ' given', 
                E_USER_WARNING);
            return false;
        }

        if (strlen($string) < 8) {
            user_error('convert_uuencode() The given parameter is not'
                . ' a valid uuencoded string', E_USER_WARNING);
            return false;
        }

        $decoded = '';
        foreach (explode("\n", $string) as $line) {

            $c = count($bytes = unpack('c*', substr(trim($line), 1)));

            while ($c % 4) {
                $bytes[++$c] = 0;
            }

            foreach (array_chunk($bytes, 4) as $b) {
                $b0 = $b[0] == 0x60 ? 0 : $b[0] - 0x20;
                $b1 = $b[1] == 0x60 ? 0 : $b[1] - 0x20;
                $b2 = $b[2] == 0x60 ? 0 : $b[2] - 0x20;
                $b3 = $b[3] == 0x60 ? 0 : $b[3] - 0x20;
                
                $b0 <<= 2;
                $b0 |= ($b1 >> 4) & 0x03;
                $b1 <<= 4;
                $b1 |= ($b2 >> 2) & 0x0F;
                $b2 <<= 6;
                $b2 |= $b3 & 0x3F;
                
                $decoded .= pack('c*', $b0, $b1, $b2);
            }
        }

        return rtrim($decoded, "\0");
    }
}
?>

Table of Contents

 About This Book

UUEncode Encoding

 UUEnccode Algorithm

 Sun Implementation of UUEnccode in Java

 Correction to Sun Implementation of UUEnccode

PHP - convert_uuencode() and convert_uudecode()

 Base64 Encoding

 Base32 Encoding

 URL Encoding, URI Encoding, or Percent Encoding

 References

 PDF Printing Version