Definitive Guide to Apache mod_rewrite

159 Pages·2006·1.02 MB·English

5610_FM_final.qxd 1/10/06 4:56 PM Page i
The Definitive Guide to
Apache mod_rewrite
Rich Bowen
5610_FM_final.qxd 1/10/06 4:56 PM Page ii
The Definitive Guide to Apache mod_rewrite
Copyright © 2006 by Rich Bowen
All rights reserved. No part of this work may be reproduced or transmitted in any form or by any means,
electronic or mechanical, including photocopying, recording, or by any information storage or retrieval
system, without the prior written permission of the copyright owner and the publisher.
ISBN-13: 978-1-59059-561-9
ISBN-10: 1-59059-561-0
Library of Congress Cataloging-in-Publication data is available upon request.
Printed and bound in the United States of America 9 8 7 6 5 4 3 2 1
Trademarked names may appear in this book. Rather than use a trademark symbol with every occurrence
of a trademarked name, we use the names only in an editorial fashion and to the benefit of the trademark
owner, with no intention of infringement of the trademark.
Lead Editor: Jason Gilmore
Technical Reviewer: Mads Toftum
Editorial Board: Steve Anglin, Dan Appleman, Ewan Buckingham, Gary Cornell, Tony Davis, Jason Gilmore,
Jonathan Hassell, Chris Mills, Dominic Shakeshaft, Jim Sumser
Project Manager: Kylie Johnston
Copy Edit Manager: Nicole LeClerc
Copy Editor: Nicole LeClerc
Assistant Production Director: Kari Brooks-Copony
Production Editor: Lori Bring
Compositor: Linda Weidemann, Wolf Creek Press
Proofreader: Linda Seifert
Indexer: Carol Burbo
Artist: Kinetic Publishing Services, LLC
Cover Designer: Kurt Krames
Manufacturing Director: Tom Debolski
Distributed to the book trade worldwide by Springer-Verlag New York, Inc., 233 Spring Street, 6th Floor,
New York, NY 10013. Phone 1-800-SPRINGER, fax [phone], e-mail [email protected], or
visit http://www.springeronline.com.
For information on translations, please contact Apress directly at 2560 Ninth Street, Suite 219, Berkeley,
CA 94710. Phone [phone], fax [phone], e-mail [email protected], or visit http://www.apress.com.
The information in this book is distributed on an “as is” basis, without warranty. Although every precaution
has been taken in the preparation of this work, neither the author(s) nor Apress shall have any liability to
any person or entity with respect to any loss or damage caused or alleged to be caused directly or indirectly
by the information contained in this work.
The source code for this book is available to readers at http://www.apress.comin the Source Code section.
5610_FM_final.qxd 1/10/06 4:56 PM Page iii
To my Jumbly girl,who always knows
how to make me smile.
5610_FM_final.qxd 1/10/06 4:56 PM Page iv
5610_FM_final.qxd 1/10/06 4:56 PM Page v
Contents at a Glance
About the Author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
■ CHAPTER 1 An Introduction to mod_rewrite. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
■ CHAPTER 2 Regular Expressions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
■ CHAPTER 3 Installing and Configuring mod_rewrite . . . . . . . . . . . . . . . . . . . . . . . . 21
■ CHAPTER 4 The RewriteRule Directive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
■ CHAPTER 5 The RewriteCond Directive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
■ CHAPTER 6 The RewriteMap Directive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
■ CHAPTER 7 Basic Rewrites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
■ CHAPTER 8 Conditional Rewrites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
■ CHAPTER 9 Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
■ CHAPTER 10 Virtual Hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
■ CHAPTER 11 Proxying. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
■ CHAPTER 12 Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
■ APPENDIX Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
■ INDEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
v
5610_FM_final.qxd 1/10/06 4:56 PM Page vi
5610_FM_final.qxd 1/10/06 4:56 PM Page vii
Contents
About the Author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
■ CHAPTER 1 An Introduction to mod_rewrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
When to Use mod_rewrite. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
“Clean”URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Mass Virtual Hosting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Site Rearrangement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Conditional Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Other Stuff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
When Not to Use mod_rewrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Simple Redirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
More Complicated Redirects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Virtual Hosts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Other Stuff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
■ CHAPTER 2 Regular Expressions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
The Building Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Matching Anything (.) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Escaping Characters (\) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Anchoring Text to the Start and End (^ and $). . . . . . . . . . . . . . . . . . . 9
Matching One or More Characters (+). . . . . . . . . . . . . . . . . . . . . . . . . 10
Matching Zero or More Characters (*). . . . . . . . . . . . . . . . . . . . . . . . . 10
Greedy Matching. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Making a Match Optional (?) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
vii
5610_FM_final.qxd 1/10/06 4:56 PM Page viii
viii ■ CONTENTS
Grouping and Capturing ( () ). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Matching One of a Group of Characters ([ ]). . . . . . . . . . . . . . . . . . . . 13
Negation (!). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Regex Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Email Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Phone Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Matching URIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Regex Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Rebug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Regex Coach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
■ CHAPTER 3 Installing and Configuring mod_rewrite . . . . . . . . . . . . . . . . . . 21
Third-Party Distributions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Installing mod_rewrite. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Static vs.Shared Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Installing from Source:Static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Installing from Source:Shared . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Enabling mod_rewrite:Binary Installation. . . . . . . . . . . . . . . . . . . . . . 25
Testing Whether mod_rewrite Is Correctly Installed . . . . . . . . . . . . . 27
If You’re Not the System Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Enabling the RewriteLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
■ CHAPTER 4 The RewriteRule Directive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Introducing RewriteRule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
RewriteRule Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
RewriteRule Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Rewrite Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
RewriteRule Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
5610_FM_final.qxd 1/10/06 4:56 PM Page ix
■ CONTENTS ix
■ CHAPTER 5 The RewriteCond Directive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
RewriteCond Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
RewriteCond Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Time-Based Redirection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
RewriteCond Additional Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Image Theft. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
RewriteCond Pattern. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
RewriteCond Modifier Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Looping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
■ CHAPTER 6 The RewriteMap Directive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
RewriteMap Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Map Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
txt Map Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Randomized Rewrites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Hash-Type Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
External Programs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Internal Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
■ CHAPTER 7 Basic Rewrites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Adjusting URLs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Problem:We Want to Rewrite Path Information
to a Query String (Example 1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Problem:We Want to Rewrite Path Information
to a Query String (Example 2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Problem:We Want to Rewrite Path Information
to a Query String (Example 3) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Problem:We Have More Than Nine Arguments . . . . . . . . . . . . . . . . . 72