Page Menu
Home
Phorge
Search
Configure Global Search
Log In
Files
F6065567
export.inc
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
6 KB
Referenced Files
None
Subscribers
None
export.inc
View Options
<
?
php
/**
+-----------------------------------------------------------------------+
| program/steps/addressbook/export.inc |
| |
| This file is part of the Roundcube Webmail client |
| Copyright (C) 2008-2013, The Roundcube Dev Team |
| Copyright (C) 2011-2013, Kolab Systems AG |
| |
| Licensed under the GNU General Public License version 3 or |
| any later version with exceptions for skins & plugins. |
| See the README file for a full license statement. |
| |
| PURPOSE: |
| Export the selected address book as vCard file |
| |
+-----------------------------------------------------------------------+
| Author: Thomas Bruederli <roundcube@gmail.com> |
| Author: Aleksander Machniak <machniak@kolabsys.com> |
+-----------------------------------------------------------------------+
*/
$
RCMAIL
-
>
request_security_check
(
rcube_utils
::
INPUT_GET
);
// Use search result
if
(
!
empty
(
$
_REQUEST
[
'
_search
'
])
&&
isset
(
$
_SESSION
[
'
search
'
][
$
_REQUEST
[
'
_search
'
]]))
{
$
sort_col
=
$
RCMAIL
-
>
config
-
>
get
(
'
addressbook_sort_col
'
,
'
name
'
);
$
search
=
(
array
)
$
_SESSION
[
'
search
'
][
$
_REQUEST
[
'
_search
'
]];
$
records
=
array
();
// Get records from all sources
foreach
(
$
search
as
$
s
=
>
$
set
)
{
$
source
=
$
RCMAIL
-
>
get_address_book
(
$
s
);
// reset page
$
source
-
>
set_page
(
1
);
$
source
-
>
set_pagesize
(
99999
);
$
source
-
>
set_search_set
(
$
set
);
// get records
$
result
=
$
source
-
>
list_records
();
while
(
$
record
=
$
result
-
>
next
())
{
// because vcard_map is per-source we need to create vcard here
prepare_for_export
(
$
record
,
$
source
);
$
record
[
'
sourceid
'
]
=
$
s
;
$
key
=
rcube_addressbook
::
compose_contact_key
(
$
record
,
$
sort_col
);
$
records
[
$
key
]
=
$
record
;
}
unset
(
$
result
);
}
// sort the records
ksort
(
$
records
,
SORT_LOCALE_STRING
);
// create resultset object
$
count
=
count
(
$
records
);
$
result
=
new
rcube_result_set
(
$
count
);
$
result
-
>
records
=
array_values
(
$
records
);
}
// selected contacts
else
if
(
!
empty
(
$
_REQUEST
[
'
_cid
'
]))
{
$
sort_col
=
$
RCMAIL
-
>
config
-
>
get
(
'
addressbook_sort_col
'
,
'
name
'
);
$
records
=
array
();
// Selected contact IDs (with multi-source support)
$
cids
=
rcmail_get_cids
();
foreach
(
$
cids
as
$
s
=
>
$
ids
)
{
$
source
=
$
RCMAIL
-
>
get_address_book
(
$
s
);
// reset page and page size (#6103)
$
source
-
>
set_page
(
1
);
$
source
-
>
set_pagesize
(
count
(
$
ids
));
$
result
=
$
source
-
>
search
(
'
ID
'
,
$
ids
,
1
,
true
,
true
);
while
(
$
record
=
$
result
-
>
next
())
{
// because vcard_map is per-source we need to create vcard here
prepare_for_export
(
$
record
,
$
source
);
$
record
[
'
sourceid
'
]
=
$
s
;
$
key
=
rcube_addressbook
::
compose_contact_key
(
$
record
,
$
sort_col
);
$
records
[
$
key
]
=
$
record
;
}
}
ksort
(
$
records
,
SORT_LOCALE_STRING
);
// create resultset object
$
count
=
count
(
$
records
);
$
result
=
new
rcube_result_set
(
$
count
);
$
result
-
>
records
=
array_values
(
$
records
);
}
// selected directory/group
else
{
$
CONTACTS
=
rcmail_contact_source
(
null
,
true
);
// get contacts for this user
$
CONTACTS
-
>
set_page
(
1
);
$
CONTACTS
-
>
set_pagesize
(
99999
);
$
result
=
$
CONTACTS
-
>
list_records
(
null
,
0
,
true
);
}
// Give plugins a possibility to implement other output formats or modify the result
$
plugin
=
$
RCMAIL
-
>
plugins
-
>
exec_hook
(
'
addressbook_export
'
,
array
(
'
result
'
=
>
$
result
));
$
result
=
$
plugin
[
'
result
'
];
if
(
$
plugin
[
'
abort
'
])
{
exit
;
}
// send downlaod headers
header
(
'
Content
-
Type
:
text
/
vcard
;
charset
=
'
.
RCUBE_CHARSET
);
header
(
'
Content
-
Disposition
:
attachment
;
filename
=
"contacts.vcf"
'
);
while
(
$
result
&&
(
$
row
=
$
result
-
>
next
()))
{
if
(
$
CONTACTS
)
{
prepare_for_export
(
$
row
,
$
CONTACTS
);
}
// fix folding and end-of-line chars
$
row
[
'
vcard
'
]
=
preg_replace
(
'
/
\
r
|\
n
\
s
+/
'
,
''
,
$
row
[
'
vcard
'
]);
$
row
[
'
vcard
'
]
=
preg_replace
(
'
/
\
n
/
'
,
rcube_vcard
::$
eol
,
$
row
[
'
vcard
'
]);
echo
rcube_vcard
::
rfc2425_fold
(
$
row
[
'
vcard
'
])
.
rcube_vcard
::$
eol
;
}
exit
;
/**
* Copy contact record properties into a vcard object
*/
function
prepare_for_export
(
&$
record
,
$
source
=
null
)
{
$
groups
=
$
source
&&
$
source
-
>
groups
&&
$
source
-
>
export_groups
?
$
source
-
>
get_record_groups
(
$
record
[
'
ID
'
])
:
null
;
$
fieldmap
=
$
source
?
$
source
-
>
vcard_map
:
null
;
if
(
empty
(
$
record
[
'
vcard
'
]))
{
$
vcard
=
new
rcube_vcard
(
$
record
[
'
vcard
'
],
RCUBE_CHARSET
,
false
,
$
fieldmap
);
$
vcard
-
>
reset
();
foreach
(
$
record
as
$
key
=
>
$
values
)
{
list
(
$
field
,
$
section
)
=
explode
(
':'
,
$
key
);
// avoid unwanted casting of DateTime objects to an array
// (same as in rcube_contacts::convert_save_data())
if
(
is_object
(
$
values
)
&&
is_a
(
$
values
,
'
DateTime
'
))
{
$
values
=
array
(
$
values
);
}
foreach
((
array
)
$
values
as
$
value
)
{
if
(
is_array
(
$
value
)
||
is_a
(
$
value
,
'
DateTime
'
)
||
@
strlen
(
$
value
))
{
$
vcard
-
>
set
(
$
field
,
$
value
,
strtoupper
(
$
section
));
}
}
}
// append group names
if
(
$
groups
)
{
$
vcard
-
>
set
(
'
groups
'
,
join
(
'
,
'
,
$
groups
),
null
);
}
$
record
[
'
vcard
'
]
=
$
vcard
-
>
export
();
}
// patch categories to alread existing vcard block
else
if
(
$
record
[
'
vcard
'
])
{
$
vcard
=
new
rcube_vcard
(
$
record
[
'
vcard
'
],
RCUBE_CHARSET
,
false
,
$
fieldmap
);
// unset CATEGORIES entry, it might be not up-to-date (#1490277)
$
vcard
-
>
set
(
'
groups
'
,
null
);
$
record
[
'
vcard
'
]
=
$
vcard
-
>
export
();
if
(
!
empty
(
$
groups
))
{
$
vgroups
=
'
CATEGORIES
:'
.
rcube_vcard
::
vcard_quote
(
$
groups
,
'
,
'
);
$
record
[
'
vcard
'
]
=
str_replace
(
'
END
:
VCARD
'
,
$
vgroups
.
rcube_vcard
::$
eol
.
'
END
:
VCARD
'
,
$
record
[
'
vcard
'
]);
}
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Fri, May 22, 4:38 AM (1 d, 14 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
727291
Default Alt Text
export.inc (6 KB)
Attached To
Mode
R3 roundcubemail
Attached
Detach File
Event Timeline
Log In to Comment