jasperla / node-vcard Goto Github PK

View Code? Open in Web Editor NEW

55.0 8.0 24.0 46 KB

parse vCard files/data into JSON

License: Other

JavaScript 100.00%

node-vcard's Introduction

node-vcard

This project is looking for a maintainer! Please open an issue if you'd like to over.

Introduction

node-vcard parses vCard data into nice JSON. It can read files from disk and then parse them with vCard.parseFile(), or the vCard data can be passed to it for direct parsing with vCard.parse().

This module only does basic validation of the files, so if you have NICKNAME field (added in version 3.0) in a 2.1 file and this causes issues elsewhere in the chain, it's your responsibility for now. Maybe in the future, it'll be ours...

Installation

npm install vcard

Usage

Please have a look at the stripped demo in bin/vcard-to-json.js. But basically you do:

var util = require('util');
var vCard = require('vcard');
var card = new vCard();
/* Use readFile() if the file is on disk. */
card.readFile("path/to/file.vcf", function(err, json) {
	console.log(util.inspect(json));
});
/* Use readData() otherwise. */
card.readData(String_with_vCard_data, function(err, json) {
	console.log(util.inspect(json));
});

Running the Unit Tests

Run the following commands to run the tests:

npm install
grunt

The tests will be run as soon as you change code or the vCards in the spec/ folder.

To add a test, simply add a vCard to the spec/ folder with the following name convention: vCard-version-bug.vcf

Testing with private vCards

If you want to bulk test you private vCards without running into the risk of commiting them, create the following directory and add the files in there. They will be ignored by git.

mkdir spec/private-vcards

Known bugs/limitations

Entries spanning multiple lines are currently treated as incorrect data.
Multiple entries (such as two TEL) will result in only the first one being recorded into the final JSON.

Author

Distributed under the MIT/X11 license (see the file COPYING)

node-vcard's People

Contributors

Stargazers

Watchers

node-vcard's Issues

Maintainer?

I'd be open to be maintainer.

Fixed a bug for you

My vards have ';' instead of ':'

I am getting adressbook from iphone...

it is a little sloppy for me to find and replace all ';' with ':' in my vcard data.
Plus it could add a bug because the logic is not 100% correct...

can you please update your regexp to support ';' as well as ':'

I did this quick fix:

Inside the vcard.js

line 261
changed
if (data[f].match(/^(VERSION|FN):/)) {
to
if (data[f].match(/^(VERSION|FN)/)) {

line 275
changed
if (data[f].match(/^N:/)) {
to
if (data[f].match(/^N/)) {

Thanks buddy.

quoted-printable not handled correctly

My Source data (from sipgate.de API, extended by VERSION:2.1\r\n):

BEGIN:VCARD\r\nVERSION:2.1\r\nFN;quoted-printable:Peter Pan\r\nNOTE;quoted-printable:\r\nTEL;cell:+49123123123123\r\nEND:VCARD

This is always treated as invalid data because the validator cannot find a FN entry. But it's present with a semicolon and quoted-printable which is valid I think (as of http://www.imc.org/pdi/vcard-21.txt).

Version Validation Returning False Negative

Version validation with the following text says that there is no version.

BEGIN:VCARD
VERSION:2.1
TEL;CHARSET=utf-8;WORK;VOICE:(212) 9928540
TEL;CHARSET=utf-8;CELL;VOICE:(646) 7727032
EMAIL;CHARSET=utf-8:[email protected]
LABEL;CHARSET=utf-8;WORK:Palladium Athletic Facility 140 East 14th Street New York, NY 10003
ADR;CHARSET=utf-8;WORK:;;Palladium Athletic Facility 140 East 14th Street;New York;NY;10003;
N;CHARSET=utf-8:Lefevre;Noah;D.;;
FN;CHARSET=utf-8:Noah D. Lefevre
ORG;CHARSET=utf-8:NYU
TITLE;CHARSET=utf-8:Associate Director of Athletics
NOTE;ENCODING=QUOTED-PRINTABLE;CHARSET=utf-8:NYU=0D=0A=
ATHLKTIC8=0D=0A=
Noah D. LeFevre=0D=0A=
Associate Director of Athletics=0D=0A=
Palladium Athletic Facility=0D=0A=
140 East 14th Street=0D=0A=
New York, NY 10003=0D=0A=
Office: (212) 992-8540=0D=0A=
Cell: (646) 772-7032=0D=0A=
Email: [email protected]
REV:09072016142221
END:VCARD

Escaped colons are improperly parsed

Google gives back a URL like so:

'URL:https\\://plus.google.com/u/0/38497128973128932',

The colon has been escaped with a double backslash. Once it has been parsed, the output is simply:

https\

This means that the colon was not escaped at all.

If you are willing to accept, a pull request can be made to fix this.

Single output value for multiple input values of same type

Multiple values for a field seem to be ignored, e.g.: The following .vcf (taken from this projects samples)

BEGIN:VCARD
VERSION:2.1
X-FOO:FOO
N:Gump;Forrest
FN:Forrest Gump
ORG:Bubba Gump Shrimp Co.
TITLE:Shrimp Man
TEL;WORK;VOICE:(111) 555-1212
TEL;HOME;VOICE:(404) 555-1212
ADR;WORK:;;100 Waters Edge;Baytown;LA;30314;United States of America
LABEL;WORK;ENCODING=QUOTED-PRINTABLE:100 Waters Edge=0D=0ABaytown, LA 30314=0D=0AUnited States of America
ADR;HOME:;;42 Plantation St.;Baytown;LA;30314;United States of America
LABEL;HOME;ENCODING=QUOTED-PRINTABLE:42 Plantation St.=0D=0ABaytown, LA 30314=0D=0AUnited States of America
EMAIL;PREF;INTERNET:[email protected]
REV:20080424T195243Z
END:VCARD

produces the following result:

{ REV: '20080424T195243Z',
  TITLE: 'Shrimp Man',
  FN: 'Forrest Gump',
  'X-FOO': 'FOO',
  VERSION: '2.1',
  EMAIL:
   { type: [ 'INTERNET', 'PREF' ],
     value: '[email protected]' },
  LABEL:
   { type: [ 'ENCODING=QUOTED-PRINTABLE', 'WORK' ],
     value: '100 Waters Edge=0D=0ABaytown, LA 30314=0D=0AUnited States of Americ
a' },
  ADR:
   { type: [ 'WORK' ],
     value: ';;100 Waters Edge;Baytown;LA;30314;United States of America' },
  TEL: { type: [ 'VOICE', 'WORK' ], value: '(111) 555-1212' },
  ORG: 'Bubba Gump Shrimp Co.',
  N: 'Gump, Forrest' }

Expected for key TEL to see an array holding multiple entries:

TEL;WORK;VOICE:(111) 555-1212
TEL;HOME;VOICE:(404) 555-1212

Vendor specific tags cause parsing failure

It looks like Vendor specific tags as described in the RFC are not handled.

From https://datatracker.ietf.org/doc/html/rfc6350:

vCard elements belonging to the vendor namespace will be
distinguished by the "VND-" prefix. This is followed by an IANA-
registered Private Enterprise Number (PEN), a dash, and a vCard
element designation of the vendor's choosing (e.g., "VND-123456-
MUDPIE").

The defect looks like it's in this.getValidationError() where it checks for valid tags using:

			if (!(u.contains(validFields.singleText, field) ||
			      u.contains(validFields.multipleText, field) ||
			      u.contains(validFields.rfc2425, field) ||
			      u.contains(validFields.singleBinary, field) ||
			      u.contains(validFields.structured, field) ||
			      field.match(/^X-.*/))){

That code needs an additional check as in:

			if (!(u.contains(validFields.singleText, field) ||
			      u.contains(validFields.multipleText, field) ||
			      u.contains(validFields.rfc2425, field) ||
			      u.contains(validFields.singleBinary, field) ||
			      u.contains(validFields.structured, field) ||
			      field.match(/^VND-.*/) ||
			      field.match(/^X-.*/))){

vCards are printed to console

I found a leftover console.info call to print the vcards, it's on line 77 of file vcard.js, could you please remove it? Seems like leftover debugging logic...