jscoverage/trunk/instrument.c

/*
    instrument.c - file and directory instrumentation routines
    Copyright (C) 2007, 2008 siliconforks.com

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

#include <config.h>

#include "instrument.h"

#include <assert.h>
#include <errno.h>
#include <string.h>

#include <dirent.h>
#include <sys/stat.h>
#include <sys/types.h>

#include "encoding.h"
#include "global.h"
#include "instrument-js.h"
#include "resource-manager.h"
#include "util.h"

static int g_verbose = 0;

static int string_ends_with(const char * s, const char * suffix) {
  size_t length = strlen(s);
  size_t suffix_length = strlen(suffix);
  if (length < suffix_length) {
    return 0;
  }
  return strcasecmp(s + (length - suffix_length), suffix) == 0;
}

static enum FileType get_file_type(const char * file) {
  if (string_ends_with(file, ".js")) {
    return FILE_TYPE_JS;
  }
  else if (string_ends_with(file, ".html") || string_ends_with(file, ".htm")) {
    return FILE_TYPE_HTML;
  }
  else {
    return FILE_TYPE_OTHER;
  }
}

static void check_same_file(const char * file1, const char * file2) {
  if (is_same_file(file1, file2)) {
    fatal("source and destination are the same");
  }
}

static void check_contains_file(const char * file1, const char * file2) {
  if (contains_file(file1, file2)) {
    fatal("%s contains %s", file1, file2);
  }
}

static void instrument_file(const char * source_file, const char * destination_file, const char * id, int instrumenting) {
  if (g_verbose) {
    printf("Instrumenting file %s\n", id);
  }

  /* check if they are the same */
  char * canonical_source_file = make_canonical_path(source_file);
  char * canonical_destination_file = make_canonical_path(destination_file);
  check_same_file(canonical_source_file, canonical_destination_file);
  free(canonical_source_file);
  free(canonical_destination_file);

  if (instrumenting) {
    enum FileType file_type = get_file_type(source_file);
    switch (file_type) {
    case FILE_TYPE_OTHER:
    case FILE_TYPE_HTML:
      copy_file(source_file, destination_file);
      break;
    case FILE_TYPE_JS:
      {
        FILE * input = xfopen(source_file, "r");
        FILE * output = xfopen(destination_file, "w");

        Stream * input_stream = Stream_new(0);
        Stream * output_stream = Stream_new(0);

        Stream_write_file_contents(input_stream, input);

        size_t num_characters = input_stream->length;
        uint16_t * characters = NULL;
        int result = jscoverage_bytes_to_characters(jscoverage_encoding, input_stream->data, input_stream->length, &characters, &num_characters);
        if (result == JSCOVERAGE_ERROR_ENCODING_NOT_SUPPORTED) {
          fatal("encoding %s not supported", jscoverage_encoding);
        }
        else if (result == JSCOVERAGE_ERROR_INVALID_BYTE_SEQUENCE) {
          fatal("error decoding %s in file %s", jscoverage_encoding, id);
        }
        jscoverage_instrument_js(id, characters, num_characters, output_stream);
        free(characters);

        if (fwrite(output_stream->data, 1, output_stream->length, output) != output_stream->length) {
          fatal("cannot write to file: %s", destination_file);
        }

        Stream_delete(input_stream);
        Stream_delete(output_stream);

        fclose(input);
        fclose(output);
      }
      break;
    }
  }
  else {
    copy_file(source_file, destination_file);
  }
}

void jscoverage_instrument(const char * source,
                           const char * destination,
                           int verbose,
                           char ** exclude,
                           int num_exclude,
                           char ** no_instrument,
                           int num_no_instrument)
{
  assert(source != NULL);
  assert(destination != NULL);

  g_verbose = verbose;

  /* check if they are the same */
  check_same_file(source, destination);

  /* check if source directory is an ancestor of destination directory */
  check_contains_file(source, destination);

  /* check that the source exists and is a directory */
  struct stat buf;
  xstat(source, &buf);
  if (! S_ISDIR(buf.st_mode)) {
    fatal("not a directory: %s", source);
  }

  /* if the destination directory exists, check that it is a jscoverage directory */
  if (stat(destination, &buf) == 0) {
    /* it exists */
    if (! S_ISDIR(buf.st_mode)) {
      fatal("not a directory: %s", destination);
    }
    if (! directory_is_empty(destination)) {
      char * jscoverage_html = make_path(destination, "jscoverage.html");
      if (stat(jscoverage_html, &buf) == -1) {
        fatal("refusing to overwrite directory: %s", destination);
      }
      free(jscoverage_html);
    }
  }
  else if (errno == ENOENT) {
    xmkdir(destination);
  }
  else {
    fatal("cannot stat directory: %s", destination);
  }

  /* copy the resources */
  jscoverage_copy_resources(destination);

  /* finally: copy the directory */
  struct DirListEntry * list = make_recursive_dir_list(source);
  for (struct DirListEntry * p = list; p != NULL; p = p->next) {
    char * s = make_path(source, p->name);
    char * d = make_path(destination, p->name);

    /* check if it's on the exclude list */
    for (int i = 0; i < num_exclude; i++) {
      char * x = make_path(source, exclude[i]);
      if (is_same_file(x, s) || contains_file(x, s)) {
        free(x);
        goto cleanup;
      }
      free(x);
    }

    char * dd = make_dirname(d);
    mkdirs(dd);
    free(dd);

    int instrument_this = 1;

    /* check if it's on the no-instrument list */
    for (int i = 0; i < num_no_instrument; i++) {
      char * ni = make_path(source, no_instrument[i]);
      if (is_same_file(ni, s) || contains_file(ni, s)) {
        instrument_this = 0;
      }
      free(ni);
    }

    instrument_file(s, d, p->name, instrument_this);

  cleanup:
    free(s);
    free(d);
  }
  free_dir_list(list);
}
1	/*
2	instrument.c - file and directory instrumentation routines
3	Copyright (C) 2007, 2008 siliconforks.com
4
5	This program is free software; you can redistribute it and/or modify
6	it under the terms of the GNU General Public License as published by
7	the Free Software Foundation; either version 2 of the License, or
8	(at your option) any later version.
9
10	This program is distributed in the hope that it will be useful,
11	but WITHOUT ANY WARRANTY; without even the implied warranty of
12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13	GNU General Public License for more details.
14
15	You should have received a copy of the GNU General Public License along
16	with this program; if not, write to the Free Software Foundation, Inc.,
17	51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18	*/
19
20	#include <config.h>
21
22	#include "instrument.h"
23
24	#include <assert.h>
25	#include <errno.h>
26	#include <string.h>
27
28	#include <dirent.h>
29	#include <sys/stat.h>
30	#include <sys/types.h>
31
32	#include "encoding.h"
33	#include "global.h"
34	#include "instrument-js.h"
35	#include "resource-manager.h"
36	#include "util.h"
37
38	static int g_verbose = 0;
39
40	static int string_ends_with(const char * s, const char * suffix) {
41	size_t length = strlen(s);
42	size_t suffix_length = strlen(suffix);
43	if (length < suffix_length) {
44	return 0;
45	}
46	return strcasecmp(s + (length - suffix_length), suffix) == 0;
47	}
48
49	static enum FileType get_file_type(const char * file) {
50	if (string_ends_with(file, ".js")) {
51	return FILE_TYPE_JS;
52	}
53	else if (string_ends_with(file, ".html") \|\| string_ends_with(file, ".htm")) {
54	return FILE_TYPE_HTML;
55	}
56	else {
57	return FILE_TYPE_OTHER;
58	}
59	}
60
61	static void check_same_file(const char * file1, const char * file2) {
62	if (is_same_file(file1, file2)) {
63	fatal("source and destination are the same");
64	}
65	}
66
67	static void check_contains_file(const char * file1, const char * file2) {
68	if (contains_file(file1, file2)) {
69	fatal("%s contains %s", file1, file2);
70	}
71	}
72
73	static void instrument_file(const char * source_file, const char * destination_file, const char * id, int instrumenting) {
74	if (g_verbose) {
75	printf("Instrumenting file %s\n", id);
76	}
77
78	/* check if they are the same */
79	char * canonical_source_file = make_canonical_path(source_file);
80	char * canonical_destination_file = make_canonical_path(destination_file);
81	check_same_file(canonical_source_file, canonical_destination_file);
82	free(canonical_source_file);
83	free(canonical_destination_file);
84
85	if (instrumenting) {
86	enum FileType file_type = get_file_type(source_file);
87	switch (file_type) {
88	case FILE_TYPE_OTHER:
89	case FILE_TYPE_HTML:
90	copy_file(source_file, destination_file);
91	break;
92	case FILE_TYPE_JS:
93	{
94	FILE * input = xfopen(source_file, "r");
95	FILE * output = xfopen(destination_file, "w");
96
97	Stream * input_stream = Stream_new(0);
98	Stream * output_stream = Stream_new(0);
99
100	Stream_write_file_contents(input_stream, input);
101
102	size_t num_characters = input_stream->length;
103	uint16_t * characters = NULL;
104	int result = jscoverage_bytes_to_characters(jscoverage_encoding, input_stream->data, input_stream->length, &characters, &num_characters);
105	if (result == JSCOVERAGE_ERROR_ENCODING_NOT_SUPPORTED) {
106	fatal("encoding %s not supported", jscoverage_encoding);
107	}
108	else if (result == JSCOVERAGE_ERROR_INVALID_BYTE_SEQUENCE) {
109	fatal("error decoding %s in file %s", jscoverage_encoding, id);
110	}
111	jscoverage_instrument_js(id, characters, num_characters, output_stream);
112	free(characters);
113
114	if (fwrite(output_stream->data, 1, output_stream->length, output) != output_stream->length) {
115	fatal("cannot write to file: %s", destination_file);
116	}
117
118	Stream_delete(input_stream);
119	Stream_delete(output_stream);
120
121	fclose(input);
122	fclose(output);
123	}
124	break;
125	}
126	}
127	else {
128	copy_file(source_file, destination_file);
129	}
130	}
131
132	void jscoverage_instrument(const char * source,
133	const char * destination,
134	int verbose,
135	char ** exclude,
136	int num_exclude,
137	char ** no_instrument,
138	int num_no_instrument)
139	{
140	assert(source != NULL);
141	assert(destination != NULL);
142
143	g_verbose = verbose;
144
145	/* check if they are the same */
146	check_same_file(source, destination);
147
148	/* check if source directory is an ancestor of destination directory */
149	check_contains_file(source, destination);
150
151	/* check that the source exists and is a directory */
152	struct stat buf;
153	xstat(source, &buf);
154	if (! S_ISDIR(buf.st_mode)) {
155	fatal("not a directory: %s", source);
156	}
157
158	/* if the destination directory exists, check that it is a jscoverage directory */
159	if (stat(destination, &buf) == 0) {
160	/* it exists */
161	if (! S_ISDIR(buf.st_mode)) {
162	fatal("not a directory: %s", destination);
163	}
164	if (! directory_is_empty(destination)) {
165	char * jscoverage_html = make_path(destination, "jscoverage.html");
166	if (stat(jscoverage_html, &buf) == -1) {
167	fatal("refusing to overwrite directory: %s", destination);
168	}
169	free(jscoverage_html);
170	}
171	}
172	else if (errno == ENOENT) {
173	xmkdir(destination);
174	}
175	else {
176	fatal("cannot stat directory: %s", destination);
177	}
178
179	/* copy the resources */
180	jscoverage_copy_resources(destination);
181
182	/* finally: copy the directory */
183	struct DirListEntry * list = make_recursive_dir_list(source);
184	for (struct DirListEntry * p = list; p != NULL; p = p->next) {
185	char * s = make_path(source, p->name);
186	char * d = make_path(destination, p->name);
187
188	/* check if it's on the exclude list */
189	for (int i = 0; i < num_exclude; i++) {
190	char * x = make_path(source, exclude[i]);
191	if (is_same_file(x, s) \|\| contains_file(x, s)) {
192	free(x);
193	goto cleanup;
194	}
195	free(x);
196	}
197
198	char * dd = make_dirname(d);
199	mkdirs(dd);
200	free(dd);
201
202	int instrument_this = 1;
203
204	/* check if it's on the no-instrument list */
205	for (int i = 0; i < num_no_instrument; i++) {
206	char * ni = make_path(source, no_instrument[i]);
207	if (is_same_file(ni, s) \|\| contains_file(ni, s)) {
208	instrument_this = 0;
209	}
210	free(ni);
211	}
212
213	instrument_file(s, d, p->name, instrument_this);
214
215	cleanup:
216	free(s);
217	free(d);
218	}
219	free_dir_list(list);
220	}