Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ChecksumFile |
|
| 5.0;5 |
1 | package org.codehaus.plexus.digest; | |
2 | ||
3 | /* | |
4 | * Copyright 2001-2007 The Codehaus. | |
5 | * | |
6 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
7 | * you may not use this file except in compliance with the License. | |
8 | * You may obtain a copy of the License at | |
9 | * | |
10 | * http://www.apache.org/licenses/LICENSE-2.0 | |
11 | * | |
12 | * Unless required by applicable law or agreed to in writing, software | |
13 | * distributed under the License is distributed on an "AS IS" BASIS, | |
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
15 | * See the License for the specific language governing permissions and | |
16 | * limitations under the License. | |
17 | */ | |
18 | ||
19 | import org.codehaus.plexus.util.FileUtils; | |
20 | import org.codehaus.plexus.util.StringUtils; | |
21 | ||
22 | import java.io.File; | |
23 | import java.io.FileNotFoundException; | |
24 | import java.io.IOException; | |
25 | ||
26 | /** | |
27 | * ChecksumFile | |
28 | * | |
29 | * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a> | |
30 | * @version $Id$ | |
31 | * | |
32 | * @plexus.component role="org.codehaus.plexus.digest.ChecksumFile" | |
33 | */ | |
34 | 2 | public class ChecksumFile |
35 | { | |
36 | /** | |
37 | * @plexus.requirement role-hint="sha1" | |
38 | */ | |
39 | private Digester digestSha1; | |
40 | ||
41 | /** | |
42 | * @plexus.requirement role-hint="md5"; | |
43 | */ | |
44 | private Digester digestMd5; | |
45 | ||
46 | /** | |
47 | * <p> | |
48 | * Given a checksum file, check to see if the file it represents is valid according to the checksum. | |
49 | * </p> | |
50 | * | |
51 | * <dl> | |
52 | * <lh>Terminology:</lh> | |
53 | * <dt>Checksum File</dt> | |
54 | * <dd>The file that contains the previously calculated checksum value for the reference file. | |
55 | * This is a text file with the extension ".sha1" or ".md5", and contains a single entry | |
56 | * consisting of an optional reference filename, and a checksum string. | |
57 | * </dd> | |
58 | * <dt>Reference File</dt> | |
59 | * <dd>The file that is being referenced in the checksum file.</dd> | |
60 | * </dl> | |
61 | * | |
62 | * <p> | |
63 | * NOTE: Only supports single file checksums of type MD5 or SHA1. | |
64 | * </p> | |
65 | * | |
66 | * @param checksumFile the checksum file (must end in ".sha1" or ".md5") | |
67 | * @return true if the checksum is valid for the file it represents. | |
68 | * @throws DigesterException if there is a digester problem during the check of the reference file. | |
69 | * @throws FileNotFoundException if the checksumFile itself or the file it refers to is not found. | |
70 | * @throws IOException if the reading of the checksumFile or the file it refers to fails. | |
71 | */ | |
72 | public boolean isValidChecksum( File checksumFile ) throws DigesterException, FileNotFoundException, IOException | |
73 | { | |
74 | 12 | if ( !checksumFile.exists() ) |
75 | { | |
76 | 0 | throw new FileNotFoundException( "Unable to find checksum file " + checksumFile.getAbsolutePath() ); |
77 | } | |
78 | ||
79 | 12 | if ( !checksumFile.isFile() ) |
80 | { | |
81 | 0 | throw new IOException( "Unable to load checksum from non-file " + checksumFile.getAbsolutePath() ); |
82 | } | |
83 | ||
84 | 12 | String path = checksumFile.getAbsolutePath(); |
85 | 12 | Digester digester = null; |
86 | ||
87 | 12 | if ( path.endsWith( digestMd5.getFilenameExtension() ) ) |
88 | { | |
89 | 6 | digester = digestMd5; |
90 | } | |
91 | 6 | else if ( path.endsWith( digestSha1.getFilenameExtension() ) ) |
92 | { | |
93 | 6 | digester = digestSha1; |
94 | } | |
95 | // TODO: Add more digester implementations here. | |
96 | ||
97 | 12 | if ( digester == null ) |
98 | { | |
99 | 0 | throw new DigesterException( "Unable to determine digester type from filename " + path ); |
100 | } | |
101 | ||
102 | 12 | File referenceFile = new File( path.substring( 0, path.length() - digester.getFilenameExtension().length() ) ); |
103 | ||
104 | 12 | String rawChecksum = FileUtils.fileRead( checksumFile, "UTF-8" ); |
105 | 12 | String expectedChecksum = DigestUtils.cleanChecksum( rawChecksum, digester, referenceFile.getName() ); |
106 | ||
107 | 12 | String actualChecksum = digester.calc( referenceFile ); |
108 | ||
109 | 12 | return StringUtils.equalsIgnoreCase( expectedChecksum, actualChecksum ); |
110 | } | |
111 | ||
112 | /** | |
113 | * Creates a checksum file of the provided referenceFile. | |
114 | * | |
115 | * @param referenceFile the file to checksum. | |
116 | * @param digester the digester to use. | |
117 | * @return the checksum File that was created. | |
118 | * @throws DigesterException if there was a problem calculating the checksum of the referenceFile. | |
119 | * @throws IOException if there was a problem either reading the referenceFile, or writing the checksum file. | |
120 | */ | |
121 | public File createChecksum( File referenceFile, Digester digester ) throws DigesterException, IOException | |
122 | { | |
123 | 2 | File checksumFile = new File( referenceFile.getAbsolutePath() + digester.getFilenameExtension() ); |
124 | 2 | String checksum = digester.calc( referenceFile ); |
125 | 2 | FileUtils.fileWrite( checksumFile.getAbsolutePath(), "UTF-8", checksum + " " + referenceFile.getName() ); |
126 | 2 | return checksumFile; |
127 | } | |
128 | } |